From 2399a772a8dc5322178a72709cdfb4fc9f65d6f3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:08 +0000 Subject: [PATCH 01/70] chore: update docs/dyn/index.md --- docs/dyn/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index e99387945a..5817ea4ecf 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -267,6 +267,7 @@ ## chromewebstore * [v1.1](http://googleapis.github.io/google-api-python-client/docs/dyn/chromewebstore_v1_1.html) +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/chromewebstore_v2.html) ## civicinfo From 4ae6f5bc3f1a35cd69cb589c432c299df559dacf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:08 +0000 Subject: [PATCH 02/70] feat(admin): update the api #### admin:directory_v1 The following keys were added: - schemas.BluetoothAdapterInfo (Total Keys: 7) - schemas.ChromeOsDevice.properties.bluetoothAdapterInfo (Total Keys: 3) --- .../admin_directory_v1.chromeosdevices.html | 36 +++++++++++++++++++ .../documents/admin.directory_v1.json | 28 ++++++++++++++- 2 files changed, 63 insertions(+), 1 deletion(-) diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html index 1a4ba19747..67fa223218 100644 --- a/docs/dyn/admin_directory_v1.chromeosdevices.html +++ b/docs/dyn/admin_directory_v1.chromeosdevices.html @@ -164,6 +164,12 @@

Method Details

"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. }, ], + "bluetoothAdapterInfo": [ # Output only. Information about bluetooth adapters of the device. + { # Information about a device's Bluetooth adapter. + "address": "A String", # Output only. The MAC address of the adapter. + "numConnectedDevices": 42, # Output only. The number of devices connected to this adapter. + }, + ], "bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). "chromeOsType": "A String", # Output only. Chrome OS type of the device. "cpuInfo": [ # Information regarding CPU specs in the device. @@ -363,6 +369,12 @@

Method Details

"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. }, ], + "bluetoothAdapterInfo": [ # Output only. Information about bluetooth adapters of the device. + { # Information about a device's Bluetooth adapter. + "address": "A String", # Output only. The MAC address of the adapter. + "numConnectedDevices": 42, # Output only. The number of devices connected to this adapter. + }, + ], "bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). "chromeOsType": "A String", # Output only. Chrome OS type of the device. "cpuInfo": [ # Information regarding CPU specs in the device. @@ -577,6 +589,12 @@

Method Details

"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. }, ], + "bluetoothAdapterInfo": [ # Output only. Information about bluetooth adapters of the device. + { # Information about a device's Bluetooth adapter. + "address": "A String", # Output only. The MAC address of the adapter. + "numConnectedDevices": 42, # Output only. The number of devices connected to this adapter. + }, + ], "bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). "chromeOsType": "A String", # Output only. Chrome OS type of the device. "cpuInfo": [ # Information regarding CPU specs in the device. @@ -750,6 +768,12 @@

Method Details

"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. }, ], + "bluetoothAdapterInfo": [ # Output only. Information about bluetooth adapters of the device. + { # Information about a device's Bluetooth adapter. + "address": "A String", # Output only. The MAC address of the adapter. + "numConnectedDevices": 42, # Output only. The number of devices connected to this adapter. + }, + ], "bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). "chromeOsType": "A String", # Output only. Chrome OS type of the device. "cpuInfo": [ # Information regarding CPU specs in the device. @@ -922,6 +946,12 @@

Method Details

"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. }, ], + "bluetoothAdapterInfo": [ # Output only. Information about bluetooth adapters of the device. + { # Information about a device's Bluetooth adapter. + "address": "A String", # Output only. The MAC address of the adapter. + "numConnectedDevices": 42, # Output only. The number of devices connected to this adapter. + }, + ], "bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). "chromeOsType": "A String", # Output only. Chrome OS type of the device. "cpuInfo": [ # Information regarding CPU specs in the device. @@ -1095,6 +1125,12 @@

Method Details

"path": "A String", # Output only. Path to this backlight on the system. Useful if the caller needs to correlate with other information. }, ], + "bluetoothAdapterInfo": [ # Output only. Information about bluetooth adapters of the device. + { # Information about a device's Bluetooth adapter. + "address": "A String", # Output only. The MAC address of the adapter. + "numConnectedDevices": 42, # Output only. The number of devices connected to this adapter. + }, + ], "bootMode": "A String", # The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch). "chromeOsType": "A String", # Output only. Chrome OS type of the device. "cpuInfo": [ # Information regarding CPU specs in the device. diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 21015f8f43..f159078d12 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -4671,7 +4671,7 @@ } } }, -"revision": "20250930", +"revision": "20251021", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -5059,6 +5059,24 @@ false }, "type": "object" }, +"BluetoothAdapterInfo": { +"description": "Information about a device's Bluetooth adapter.", +"id": "BluetoothAdapterInfo", +"properties": { +"address": { +"description": "Output only. The MAC address of the adapter.", +"readOnly": true, +"type": "string" +}, +"numConnectedDevices": { +"description": "Output only. The number of devices connected to this adapter.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "Building": { "description": "Public API: Resources.buildings", "id": "Building", @@ -5440,6 +5458,14 @@ false "readOnly": true, "type": "array" }, +"bluetoothAdapterInfo": { +"description": "Output only. Information about bluetooth adapters of the device.", +"items": { +"$ref": "BluetoothAdapterInfo" +}, +"readOnly": true, +"type": "array" +}, "bootMode": { "description": "The boot mode for the device. The possible values are: * `Verified`: The device is running a valid version of the Chrome OS. * `Dev`: The devices's developer hardware switch is enabled. When booted, the device has a command line shell. For an example of a developer switch, see the [Chromebook developer information](https://www.chromium.org/chromium-os/developer-information-for-chrome-os-devices/samsung-series-5-chromebook#TOC-Developer-switch).", "type": "string" From 131f59d6003dfbce3abfa00730dba9f90b9ca2ab Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:08 +0000 Subject: [PATCH 03/70] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.customJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.customJobs.resources.operations.methods.delete (Total Keys: 11) - resources.customJobs.resources.operations.methods.get (Total Keys: 11) - resources.customJobs.resources.operations.methods.list (Total Keys: 20) - resources.customJobs.resources.operations.methods.wait (Total Keys: 14) - resources.dataLabelingJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.dataLabelingJobs.resources.operations.methods.delete (Total Keys: 11) - resources.dataLabelingJobs.resources.operations.methods.get (Total Keys: 11) - resources.dataLabelingJobs.resources.operations.methods.list (Total Keys: 20) - resources.dataLabelingJobs.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.annotationSpecs.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.annotationSpecs.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.annotationSpecs.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.annotationSpecs.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.annotationSpecs.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.dataItems.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.dataItems.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.dataItems.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.dataItems.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.dataItems.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.savedQueries.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.savedQueries.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.savedQueries.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.savedQueries.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.savedQueries.resources.operations.methods.wait (Total Keys: 14) - resources.deploymentResourcePools.resources.operations.methods.cancel (Total Keys: 11) - resources.deploymentResourcePools.resources.operations.methods.delete (Total Keys: 11) - resources.deploymentResourcePools.resources.operations.methods.get (Total Keys: 11) - resources.deploymentResourcePools.resources.operations.methods.list (Total Keys: 20) - resources.deploymentResourcePools.resources.operations.methods.wait (Total Keys: 14) - resources.endpoints.resources.operations.methods.cancel (Total Keys: 11) - resources.endpoints.resources.operations.methods.delete (Total Keys: 11) - resources.endpoints.resources.operations.methods.get (Total Keys: 11) - resources.endpoints.resources.operations.methods.list (Total Keys: 20) - resources.endpoints.resources.operations.methods.wait (Total Keys: 14) - resources.featureGroups.resources.features.resources.operations.methods.delete (Total Keys: 11) - resources.featureGroups.resources.features.resources.operations.methods.get (Total Keys: 11) - resources.featureGroups.resources.features.resources.operations.methods.listWait (Total Keys: 20) - resources.featureGroups.resources.features.resources.operations.methods.wait (Total Keys: 14) - resources.featureGroups.resources.operations.methods.delete (Total Keys: 11) - resources.featureGroups.resources.operations.methods.get (Total Keys: 11) - resources.featureGroups.resources.operations.methods.listWait (Total Keys: 20) - resources.featureGroups.resources.operations.methods.wait (Total Keys: 14) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.delete (Total Keys: 11) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.get (Total Keys: 11) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.listWait (Total Keys: 20) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.wait (Total Keys: 14) - resources.featureOnlineStores.resources.operations.methods.delete (Total Keys: 11) - resources.featureOnlineStores.resources.operations.methods.get (Total Keys: 11) - resources.featureOnlineStores.resources.operations.methods.listWait (Total Keys: 20) - resources.featureOnlineStores.resources.operations.methods.wait (Total Keys: 14) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.cancel (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.delete (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.get (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.list (Total Keys: 20) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.wait (Total Keys: 14) - resources.featurestores.resources.entityTypes.resources.operations.methods.cancel (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.operations.methods.delete (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.operations.methods.get (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.operations.methods.list (Total Keys: 20) - resources.featurestores.resources.entityTypes.resources.operations.methods.wait (Total Keys: 14) - resources.featurestores.resources.operations.methods.cancel (Total Keys: 11) - resources.featurestores.resources.operations.methods.delete (Total Keys: 11) - resources.featurestores.resources.operations.methods.get (Total Keys: 11) - resources.featurestores.resources.operations.methods.list (Total Keys: 20) - resources.featurestores.resources.operations.methods.wait (Total Keys: 14) - resources.hyperparameterTuningJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.hyperparameterTuningJobs.resources.operations.methods.delete (Total Keys: 11) - resources.hyperparameterTuningJobs.resources.operations.methods.get (Total Keys: 11) - resources.hyperparameterTuningJobs.resources.operations.methods.list (Total Keys: 20) - resources.hyperparameterTuningJobs.resources.operations.methods.wait (Total Keys: 14) - resources.indexEndpoints.resources.operations.methods.cancel (Total Keys: 11) - resources.indexEndpoints.resources.operations.methods.delete (Total Keys: 11) - resources.indexEndpoints.resources.operations.methods.get (Total Keys: 11) - resources.indexEndpoints.resources.operations.methods.list (Total Keys: 20) - resources.indexEndpoints.resources.operations.methods.wait (Total Keys: 14) - resources.indexes.resources.operations.methods.cancel (Total Keys: 11) - resources.indexes.resources.operations.methods.delete (Total Keys: 11) - resources.indexes.resources.operations.methods.get (Total Keys: 11) - resources.indexes.resources.operations.methods.list (Total Keys: 20) - resources.indexes.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.artifacts.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.artifacts.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.artifacts.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.artifacts.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.artifacts.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.contexts.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.contexts.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.contexts.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.contexts.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.contexts.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.executions.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.executions.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.executions.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.executions.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.executions.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.operations.methods.wait (Total Keys: 14) - resources.migratableResources.resources.operations.methods.cancel (Total Keys: 11) - resources.migratableResources.resources.operations.methods.delete (Total Keys: 11) - resources.migratableResources.resources.operations.methods.get (Total Keys: 11) - resources.migratableResources.resources.operations.methods.list (Total Keys: 20) - resources.migratableResources.resources.operations.methods.wait (Total Keys: 14) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.delete (Total Keys: 11) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.get (Total Keys: 11) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.list (Total Keys: 20) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.wait (Total Keys: 14) - resources.models.resources.evaluations.resources.operations.methods.cancel (Total Keys: 11) - resources.models.resources.evaluations.resources.operations.methods.delete (Total Keys: 11) - resources.models.resources.evaluations.resources.operations.methods.get (Total Keys: 11) - resources.models.resources.evaluations.resources.operations.methods.list (Total Keys: 20) - resources.models.resources.evaluations.resources.operations.methods.wait (Total Keys: 14) - resources.models.resources.operations.methods.cancel (Total Keys: 11) - resources.models.resources.operations.methods.delete (Total Keys: 11) - resources.models.resources.operations.methods.get (Total Keys: 11) - resources.models.resources.operations.methods.list (Total Keys: 20) - resources.models.resources.operations.methods.wait (Total Keys: 14) - resources.notebookExecutionJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.notebookExecutionJobs.resources.operations.methods.delete (Total Keys: 11) - resources.notebookExecutionJobs.resources.operations.methods.get (Total Keys: 11) - resources.notebookExecutionJobs.resources.operations.methods.list (Total Keys: 20) - resources.notebookExecutionJobs.resources.operations.methods.wait (Total Keys: 14) - resources.notebookRuntimeTemplates.resources.operations.methods.cancel (Total Keys: 11) - resources.notebookRuntimeTemplates.resources.operations.methods.delete (Total Keys: 11) - resources.notebookRuntimeTemplates.resources.operations.methods.get (Total Keys: 11) - resources.notebookRuntimeTemplates.resources.operations.methods.list (Total Keys: 20) - resources.notebookRuntimeTemplates.resources.operations.methods.wait (Total Keys: 14) - resources.notebookRuntimes.resources.operations.methods.cancel (Total Keys: 11) - resources.notebookRuntimes.resources.operations.methods.delete (Total Keys: 11) - resources.notebookRuntimes.resources.operations.methods.get (Total Keys: 11) - resources.notebookRuntimes.resources.operations.methods.list (Total Keys: 20) - resources.notebookRuntimes.resources.operations.methods.wait (Total Keys: 14) - resources.operations.methods.cancel (Total Keys: 11) - resources.operations.methods.delete (Total Keys: 11) - resources.operations.methods.get (Total Keys: 11) - resources.operations.methods.list (Total Keys: 18) - resources.operations.methods.wait (Total Keys: 14) - resources.persistentResources.resources.operations.methods.cancel (Total Keys: 11) - resources.persistentResources.resources.operations.methods.delete (Total Keys: 11) - resources.persistentResources.resources.operations.methods.get (Total Keys: 11) - resources.persistentResources.resources.operations.methods.list (Total Keys: 20) - resources.persistentResources.resources.operations.methods.wait (Total Keys: 14) - resources.pipelineJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.pipelineJobs.resources.operations.methods.delete (Total Keys: 11) - resources.pipelineJobs.resources.operations.methods.get (Total Keys: 11) - resources.pipelineJobs.resources.operations.methods.list (Total Keys: 20) - resources.pipelineJobs.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.publishers.resources.models.methods.embedContent (Total Keys: 12) - resources.ragCorpora.resources.operations.methods.cancel (Total Keys: 11) - resources.ragCorpora.resources.operations.methods.delete (Total Keys: 11) - resources.ragCorpora.resources.operations.methods.get (Total Keys: 11) - resources.ragCorpora.resources.operations.methods.list (Total Keys: 20) - resources.ragCorpora.resources.operations.methods.wait (Total Keys: 14) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel (Total Keys: 11) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete (Total Keys: 11) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.get (Total Keys: 11) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.list (Total Keys: 20) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait (Total Keys: 14) - resources.ragEngineConfig.resources.operations.methods.cancel (Total Keys: 11) - resources.ragEngineConfig.resources.operations.methods.delete (Total Keys: 11) - resources.ragEngineConfig.resources.operations.methods.get (Total Keys: 11) - resources.ragEngineConfig.resources.operations.methods.list (Total Keys: 20) - resources.ragEngineConfig.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.operations.methods.wait (Total Keys: 14) - resources.schedules.resources.operations.methods.cancel (Total Keys: 11) - resources.schedules.resources.operations.methods.delete (Total Keys: 11) - resources.schedules.resources.operations.methods.get (Total Keys: 11) - resources.schedules.resources.operations.methods.list (Total Keys: 20) - resources.schedules.resources.operations.methods.wait (Total Keys: 14) - resources.specialistPools.resources.operations.methods.cancel (Total Keys: 11) - resources.specialistPools.resources.operations.methods.delete (Total Keys: 11) - resources.specialistPools.resources.operations.methods.get (Total Keys: 11) - resources.specialistPools.resources.operations.methods.list (Total Keys: 20) - resources.specialistPools.resources.operations.methods.wait (Total Keys: 14) - resources.studies.resources.operations.methods.cancel (Total Keys: 11) - resources.studies.resources.operations.methods.delete (Total Keys: 11) - resources.studies.resources.operations.methods.get (Total Keys: 11) - resources.studies.resources.operations.methods.list (Total Keys: 20) - resources.studies.resources.operations.methods.wait (Total Keys: 14) - resources.studies.resources.trials.resources.operations.methods.cancel (Total Keys: 11) - resources.studies.resources.trials.resources.operations.methods.delete (Total Keys: 11) - resources.studies.resources.trials.resources.operations.methods.get (Total Keys: 11) - resources.studies.resources.trials.resources.operations.methods.list (Total Keys: 20) - resources.studies.resources.trials.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.experiments.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.experiments.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.operations.methods.wait (Total Keys: 14) - resources.trainingPipelines.resources.operations.methods.cancel (Total Keys: 11) - resources.trainingPipelines.resources.operations.methods.delete (Total Keys: 11) - resources.trainingPipelines.resources.operations.methods.get (Total Keys: 11) - resources.trainingPipelines.resources.operations.methods.list (Total Keys: 20) - resources.trainingPipelines.resources.operations.methods.wait (Total Keys: 14) - resources.tuningJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.tuningJobs.resources.operations.methods.delete (Total Keys: 11) - resources.tuningJobs.resources.operations.methods.get (Total Keys: 11) - resources.tuningJobs.resources.operations.methods.list (Total Keys: 20) - schemas.GoogleCloudAiplatformV1CustomCodeExecutionSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1DatasetDistribution (Total Keys: 37) - schemas.GoogleCloudAiplatformV1EmbedContentRequest (Total Keys: 7) - schemas.GoogleCloudAiplatformV1EmbedContentResponse (Total Keys: 10) - schemas.GoogleCloudAiplatformV1EvaluationInstance.properties.agentData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationInstanceAgentConfig (Total Keys: 9) - schemas.GoogleCloudAiplatformV1EvaluationInstanceAgentData (Total Keys: 20) - schemas.GoogleCloudAiplatformV1EvaluationRunMetric.properties.metricConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1FunctionResponse.properties.parts (Total Keys: 2) - schemas.GoogleCloudAiplatformV1FunctionResponseBlob (Total Keys: 6) - schemas.GoogleCloudAiplatformV1FunctionResponseFileData (Total Keys: 5) - schemas.GoogleCloudAiplatformV1FunctionResponsePart (Total Keys: 4) - schemas.GoogleCloudAiplatformV1GeminiPreferenceExample (Total Keys: 11) - schemas.GoogleCloudAiplatformV1GenerateInstanceRubricsRequest.properties.agentConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ImageConfig.properties.imageOutputOptions.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ImageConfig.properties.personGeneration.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ImageConfigImageOutputOptions (Total Keys: 5) - schemas.GoogleCloudAiplatformV1Metric.properties.customCodeExecutionSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1PredictRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudAiplatformV1PreferenceOptimizationDataStats (Total Keys: 29) - schemas.GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters (Total Keys: 9) - schemas.GoogleCloudAiplatformV1PreferenceOptimizationSpec (Total Keys: 6) - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudAiplatformV1RagCorpus.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1ReasoningEngineSpec.properties.sourceCodeSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec (Total Keys: 14) - schemas.GoogleCloudAiplatformV1Tool.properties.computerUse.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ToolComputerUse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1TuningDataStats.properties.preferenceOptimizationDataStats (Total Keys: 2) - schemas.GoogleCloudAiplatformV1TuningJob.properties.preferenceOptimizationSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1UsageMetadata (Total Keys: 31) The following keys were changed: - endpoints (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1EventActions.properties.transferToAgent (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec.properties.evaluationConfig.$ref (Total Keys: 1) The following keys were added: - resources.agents.resources.operations.methods.cancel (Total Keys: 11) - resources.agents.resources.operations.methods.delete (Total Keys: 11) - resources.agents.resources.operations.methods.get (Total Keys: 11) - resources.agents.resources.operations.methods.list (Total Keys: 20) - resources.agents.resources.operations.methods.wait (Total Keys: 14) - resources.apps.resources.operations.methods.cancel (Total Keys: 11) - resources.apps.resources.operations.methods.delete (Total Keys: 11) - resources.apps.resources.operations.methods.get (Total Keys: 11) - resources.apps.resources.operations.methods.list (Total Keys: 20) - resources.apps.resources.operations.methods.wait (Total Keys: 14) - resources.customJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.customJobs.resources.operations.methods.delete (Total Keys: 11) - resources.customJobs.resources.operations.methods.get (Total Keys: 11) - resources.customJobs.resources.operations.methods.list (Total Keys: 20) - resources.customJobs.resources.operations.methods.wait (Total Keys: 14) - resources.dataLabelingJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.dataLabelingJobs.resources.operations.methods.delete (Total Keys: 11) - resources.dataLabelingJobs.resources.operations.methods.get (Total Keys: 11) - resources.dataLabelingJobs.resources.operations.methods.list (Total Keys: 20) - resources.dataLabelingJobs.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.annotationSpecs.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.annotationSpecs.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.annotationSpecs.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.annotationSpecs.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.annotationSpecs.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.dataItems.resources.annotations.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.dataItems.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.dataItems.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.dataItems.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.dataItems.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.dataItems.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.operations.methods.wait (Total Keys: 14) - resources.datasets.resources.savedQueries.resources.operations.methods.cancel (Total Keys: 11) - resources.datasets.resources.savedQueries.resources.operations.methods.delete (Total Keys: 11) - resources.datasets.resources.savedQueries.resources.operations.methods.get (Total Keys: 11) - resources.datasets.resources.savedQueries.resources.operations.methods.list (Total Keys: 20) - resources.datasets.resources.savedQueries.resources.operations.methods.wait (Total Keys: 14) - resources.deploymentResourcePools.resources.operations.methods.cancel (Total Keys: 11) - resources.deploymentResourcePools.resources.operations.methods.delete (Total Keys: 11) - resources.deploymentResourcePools.resources.operations.methods.get (Total Keys: 11) - resources.deploymentResourcePools.resources.operations.methods.list (Total Keys: 20) - resources.deploymentResourcePools.resources.operations.methods.wait (Total Keys: 14) - resources.edgeDevices.resources.operations.methods.cancel (Total Keys: 11) - resources.edgeDevices.resources.operations.methods.delete (Total Keys: 11) - resources.edgeDevices.resources.operations.methods.get (Total Keys: 11) - resources.edgeDevices.resources.operations.methods.list (Total Keys: 20) - resources.edgeDevices.resources.operations.methods.wait (Total Keys: 14) - resources.endpoints.resources.operations.methods.cancel (Total Keys: 11) - resources.endpoints.resources.operations.methods.delete (Total Keys: 11) - resources.endpoints.resources.operations.methods.get (Total Keys: 11) - resources.endpoints.resources.operations.methods.list (Total Keys: 20) - resources.endpoints.resources.operations.methods.wait (Total Keys: 14) - resources.evaluationItems.resources.operations.methods.delete (Total Keys: 11) - resources.evaluationItems.resources.operations.methods.get (Total Keys: 11) - resources.evaluationItems.resources.operations.methods.list (Total Keys: 20) - resources.evaluationItems.resources.operations.methods.wait (Total Keys: 14) - resources.evaluationRuns.resources.operations.methods.delete (Total Keys: 11) - resources.evaluationRuns.resources.operations.methods.get (Total Keys: 11) - resources.evaluationRuns.resources.operations.methods.list (Total Keys: 20) - resources.evaluationRuns.resources.operations.methods.wait (Total Keys: 14) - resources.evaluationSets.resources.operations.methods.delete (Total Keys: 11) - resources.evaluationSets.resources.operations.methods.get (Total Keys: 11) - resources.evaluationSets.resources.operations.methods.list (Total Keys: 20) - resources.evaluationSets.resources.operations.methods.wait (Total Keys: 14) - resources.evaluationTasks.resources.operations.methods.delete (Total Keys: 11) - resources.evaluationTasks.resources.operations.methods.get (Total Keys: 11) - resources.evaluationTasks.resources.operations.methods.list (Total Keys: 20) - resources.evaluationTasks.resources.operations.methods.wait (Total Keys: 14) - resources.exampleStores.resources.operations.methods.cancel (Total Keys: 11) - resources.exampleStores.resources.operations.methods.delete (Total Keys: 11) - resources.exampleStores.resources.operations.methods.get (Total Keys: 11) - resources.exampleStores.resources.operations.methods.list (Total Keys: 20) - resources.exampleStores.resources.operations.methods.wait (Total Keys: 14) - resources.extensionControllers.resources.operations.methods.cancel (Total Keys: 11) - resources.extensionControllers.resources.operations.methods.delete (Total Keys: 11) - resources.extensionControllers.resources.operations.methods.get (Total Keys: 11) - resources.extensionControllers.resources.operations.methods.list (Total Keys: 20) - resources.extensionControllers.resources.operations.methods.wait (Total Keys: 14) - resources.extensions.resources.operations.methods.cancel (Total Keys: 11) - resources.extensions.resources.operations.methods.delete (Total Keys: 11) - resources.extensions.resources.operations.methods.get (Total Keys: 11) - resources.extensions.resources.operations.methods.list (Total Keys: 20) - resources.extensions.resources.operations.methods.wait (Total Keys: 14) - resources.featureGroups.resources.featureMonitors.resources.operations.methods.delete (Total Keys: 11) - resources.featureGroups.resources.featureMonitors.resources.operations.methods.get (Total Keys: 11) - resources.featureGroups.resources.featureMonitors.resources.operations.methods.list (Total Keys: 20) - resources.featureGroups.resources.featureMonitors.resources.operations.methods.wait (Total Keys: 14) - resources.featureGroups.resources.features.resources.operations.methods.delete (Total Keys: 11) - resources.featureGroups.resources.features.resources.operations.methods.get (Total Keys: 11) - resources.featureGroups.resources.features.resources.operations.methods.list (Total Keys: 20) - resources.featureGroups.resources.features.resources.operations.methods.wait (Total Keys: 14) - resources.featureGroups.resources.operations.methods.delete (Total Keys: 11) - resources.featureGroups.resources.operations.methods.get (Total Keys: 11) - resources.featureGroups.resources.operations.methods.list (Total Keys: 20) - resources.featureGroups.resources.operations.methods.wait (Total Keys: 14) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.delete (Total Keys: 11) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.get (Total Keys: 11) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.list (Total Keys: 20) - resources.featureOnlineStores.resources.featureViews.resources.operations.methods.wait (Total Keys: 14) - resources.featureOnlineStores.resources.operations.methods.delete (Total Keys: 11) - resources.featureOnlineStores.resources.operations.methods.get (Total Keys: 11) - resources.featureOnlineStores.resources.operations.methods.list (Total Keys: 20) - resources.featureOnlineStores.resources.operations.methods.wait (Total Keys: 14) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.cancel (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.delete (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.get (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.list (Total Keys: 20) - resources.featurestores.resources.entityTypes.resources.features.resources.operations.methods.wait (Total Keys: 14) - resources.featurestores.resources.entityTypes.resources.operations.methods.cancel (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.operations.methods.delete (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.operations.methods.get (Total Keys: 11) - resources.featurestores.resources.entityTypes.resources.operations.methods.list (Total Keys: 20) - resources.featurestores.resources.entityTypes.resources.operations.methods.wait (Total Keys: 14) - resources.featurestores.resources.operations.methods.cancel (Total Keys: 11) - resources.featurestores.resources.operations.methods.delete (Total Keys: 11) - resources.featurestores.resources.operations.methods.get (Total Keys: 11) - resources.featurestores.resources.operations.methods.list (Total Keys: 20) - resources.featurestores.resources.operations.methods.wait (Total Keys: 14) - resources.hyperparameterTuningJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.hyperparameterTuningJobs.resources.operations.methods.delete (Total Keys: 11) - resources.hyperparameterTuningJobs.resources.operations.methods.get (Total Keys: 11) - resources.hyperparameterTuningJobs.resources.operations.methods.list (Total Keys: 20) - resources.hyperparameterTuningJobs.resources.operations.methods.wait (Total Keys: 14) - resources.indexEndpoints.resources.operations.methods.cancel (Total Keys: 11) - resources.indexEndpoints.resources.operations.methods.delete (Total Keys: 11) - resources.indexEndpoints.resources.operations.methods.get (Total Keys: 11) - resources.indexEndpoints.resources.operations.methods.list (Total Keys: 20) - resources.indexEndpoints.resources.operations.methods.wait (Total Keys: 14) - resources.indexes.resources.operations.methods.cancel (Total Keys: 11) - resources.indexes.resources.operations.methods.delete (Total Keys: 11) - resources.indexes.resources.operations.methods.get (Total Keys: 11) - resources.indexes.resources.operations.methods.list (Total Keys: 20) - resources.indexes.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.artifacts.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.artifacts.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.artifacts.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.artifacts.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.artifacts.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.contexts.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.contexts.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.contexts.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.contexts.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.contexts.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.executions.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.executions.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.executions.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.executions.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.executions.resources.operations.methods.wait (Total Keys: 14) - resources.metadataStores.resources.operations.methods.cancel (Total Keys: 11) - resources.metadataStores.resources.operations.methods.delete (Total Keys: 11) - resources.metadataStores.resources.operations.methods.get (Total Keys: 11) - resources.metadataStores.resources.operations.methods.list (Total Keys: 20) - resources.metadataStores.resources.operations.methods.wait (Total Keys: 14) - resources.migratableResources.resources.operations.methods.cancel (Total Keys: 11) - resources.migratableResources.resources.operations.methods.delete (Total Keys: 11) - resources.migratableResources.resources.operations.methods.get (Total Keys: 11) - resources.migratableResources.resources.operations.methods.list (Total Keys: 20) - resources.migratableResources.resources.operations.methods.wait (Total Keys: 14) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.delete (Total Keys: 11) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.get (Total Keys: 11) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.list (Total Keys: 20) - resources.modelDeploymentMonitoringJobs.resources.operations.methods.wait (Total Keys: 14) - resources.modelMonitors.resources.operations.methods.cancel (Total Keys: 11) - resources.modelMonitors.resources.operations.methods.delete (Total Keys: 11) - resources.modelMonitors.resources.operations.methods.get (Total Keys: 11) - resources.modelMonitors.resources.operations.methods.list (Total Keys: 20) - resources.modelMonitors.resources.operations.methods.wait (Total Keys: 14) - resources.models.resources.evaluations.resources.operations.methods.cancel (Total Keys: 11) - resources.models.resources.evaluations.resources.operations.methods.delete (Total Keys: 11) - resources.models.resources.evaluations.resources.operations.methods.get (Total Keys: 11) - resources.models.resources.evaluations.resources.operations.methods.list (Total Keys: 20) - resources.models.resources.evaluations.resources.operations.methods.wait (Total Keys: 14) - resources.models.resources.operations.methods.cancel (Total Keys: 11) - resources.models.resources.operations.methods.delete (Total Keys: 11) - resources.models.resources.operations.methods.get (Total Keys: 11) - resources.models.resources.operations.methods.list (Total Keys: 20) - resources.models.resources.operations.methods.wait (Total Keys: 14) - resources.notebookExecutionJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.notebookExecutionJobs.resources.operations.methods.delete (Total Keys: 11) - resources.notebookExecutionJobs.resources.operations.methods.get (Total Keys: 11) - resources.notebookExecutionJobs.resources.operations.methods.list (Total Keys: 20) - resources.notebookExecutionJobs.resources.operations.methods.wait (Total Keys: 14) - resources.notebookRuntimeTemplates.resources.operations.methods.cancel (Total Keys: 11) - resources.notebookRuntimeTemplates.resources.operations.methods.delete (Total Keys: 11) - resources.notebookRuntimeTemplates.resources.operations.methods.get (Total Keys: 11) - resources.notebookRuntimeTemplates.resources.operations.methods.list (Total Keys: 20) - resources.notebookRuntimeTemplates.resources.operations.methods.wait (Total Keys: 14) - resources.notebookRuntimes.resources.operations.methods.cancel (Total Keys: 11) - resources.notebookRuntimes.resources.operations.methods.delete (Total Keys: 11) - resources.notebookRuntimes.resources.operations.methods.get (Total Keys: 11) - resources.notebookRuntimes.resources.operations.methods.list (Total Keys: 20) - resources.notebookRuntimes.resources.operations.methods.wait (Total Keys: 14) - resources.operations.methods.cancel (Total Keys: 11) - resources.operations.methods.delete (Total Keys: 11) - resources.operations.methods.get (Total Keys: 11) - resources.operations.methods.list (Total Keys: 18) - resources.operations.methods.wait (Total Keys: 14) - resources.persistentResources.resources.operations.methods.cancel (Total Keys: 11) - resources.persistentResources.resources.operations.methods.delete (Total Keys: 11) - resources.persistentResources.resources.operations.methods.get (Total Keys: 11) - resources.persistentResources.resources.operations.methods.list (Total Keys: 20) - resources.persistentResources.resources.operations.methods.wait (Total Keys: 14) - resources.pipelineJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.pipelineJobs.resources.operations.methods.delete (Total Keys: 11) - resources.pipelineJobs.resources.operations.methods.get (Total Keys: 11) - resources.pipelineJobs.resources.operations.methods.list (Total Keys: 20) - resources.pipelineJobs.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.publishers.resources.models.methods.embedContent (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.rollback (Total Keys: 12) - resources.projects.resources.locations.resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy (Total Keys: 2) - resources.ragCorpora.resources.operations.methods.cancel (Total Keys: 11) - resources.ragCorpora.resources.operations.methods.delete (Total Keys: 11) - resources.ragCorpora.resources.operations.methods.get (Total Keys: 11) - resources.ragCorpora.resources.operations.methods.list (Total Keys: 20) - resources.ragCorpora.resources.operations.methods.wait (Total Keys: 14) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.cancel (Total Keys: 11) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.delete (Total Keys: 11) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.get (Total Keys: 11) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.list (Total Keys: 20) - resources.ragCorpora.resources.ragFiles.resources.operations.methods.wait (Total Keys: 14) - resources.ragEngineConfig.resources.operations.methods.cancel (Total Keys: 11) - resources.ragEngineConfig.resources.operations.methods.delete (Total Keys: 11) - resources.ragEngineConfig.resources.operations.methods.get (Total Keys: 11) - resources.ragEngineConfig.resources.operations.methods.list (Total Keys: 20) - resources.ragEngineConfig.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.examples.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.examples.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.examples.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.examples.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.memories.methods.rollback (Total Keys: 12) - resources.reasoningEngines.resources.memories.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.memories.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.memories.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.memories.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.memories.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.sandboxEnvironments.methods.create (Total Keys: 12) - resources.reasoningEngines.resources.sandboxEnvironments.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironments.methods.execute (Total Keys: 12) - resources.reasoningEngines.resources.sandboxEnvironments.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironments.methods.list (Total Keys: 18) - resources.reasoningEngines.resources.sandboxEnvironments.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironments.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironments.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sandboxEnvironments.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.sandboxEnvironments.resources.operations.methods.wait (Total Keys: 14) - resources.reasoningEngines.resources.sessions.resources.events.methods.list.parameters.orderBy (Total Keys: 2) - resources.reasoningEngines.resources.sessions.resources.operations.methods.cancel (Total Keys: 11) - resources.reasoningEngines.resources.sessions.resources.operations.methods.delete (Total Keys: 11) - resources.reasoningEngines.resources.sessions.resources.operations.methods.get (Total Keys: 11) - resources.reasoningEngines.resources.sessions.resources.operations.methods.list (Total Keys: 20) - resources.reasoningEngines.resources.sessions.resources.operations.methods.wait (Total Keys: 14) - resources.schedules.resources.operations.methods.cancel (Total Keys: 11) - resources.schedules.resources.operations.methods.delete (Total Keys: 11) - resources.schedules.resources.operations.methods.get (Total Keys: 11) - resources.schedules.resources.operations.methods.list (Total Keys: 20) - resources.schedules.resources.operations.methods.wait (Total Keys: 14) - resources.solvers.resources.operations.methods.delete (Total Keys: 11) - resources.solvers.resources.operations.methods.get (Total Keys: 11) - resources.solvers.resources.operations.methods.list (Total Keys: 20) - resources.specialistPools.resources.operations.methods.cancel (Total Keys: 11) - resources.specialistPools.resources.operations.methods.delete (Total Keys: 11) - resources.specialistPools.resources.operations.methods.get (Total Keys: 11) - resources.specialistPools.resources.operations.methods.list (Total Keys: 20) - resources.specialistPools.resources.operations.methods.wait (Total Keys: 14) - resources.studies.resources.operations.methods.cancel (Total Keys: 11) - resources.studies.resources.operations.methods.delete (Total Keys: 11) - resources.studies.resources.operations.methods.get (Total Keys: 11) - resources.studies.resources.operations.methods.list (Total Keys: 20) - resources.studies.resources.operations.methods.wait (Total Keys: 14) - resources.studies.resources.trials.resources.operations.methods.cancel (Total Keys: 11) - resources.studies.resources.trials.resources.operations.methods.delete (Total Keys: 11) - resources.studies.resources.trials.resources.operations.methods.get (Total Keys: 11) - resources.studies.resources.trials.resources.operations.methods.list (Total Keys: 20) - resources.studies.resources.trials.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.experiments.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.experiments.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.experiments.resources.runs.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.experiments.resources.runs.resources.timeSeries.resources.operations.methods.wait (Total Keys: 14) - resources.tensorboards.resources.operations.methods.cancel (Total Keys: 11) - resources.tensorboards.resources.operations.methods.delete (Total Keys: 11) - resources.tensorboards.resources.operations.methods.get (Total Keys: 11) - resources.tensorboards.resources.operations.methods.list (Total Keys: 20) - resources.tensorboards.resources.operations.methods.wait (Total Keys: 14) - resources.trainingPipelines.resources.operations.methods.cancel (Total Keys: 11) - resources.trainingPipelines.resources.operations.methods.delete (Total Keys: 11) - resources.trainingPipelines.resources.operations.methods.get (Total Keys: 11) - resources.trainingPipelines.resources.operations.methods.list (Total Keys: 20) - resources.trainingPipelines.resources.operations.methods.wait (Total Keys: 14) - resources.tuningJobs.resources.operations.methods.delete (Total Keys: 11) - schemas.GoogleCloudAiplatformV1beta1AggregationResult.properties.customCodeExecutionResult.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1CandidateResponse.properties.events (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionResult (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1EmbedContentRequest (Total Keys: 7) - schemas.GoogleCloudAiplatformV1beta1EmbedContentResponse (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1EnableModelRequest.properties.service.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstance.properties.agentData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig (Total Keys: 9) - schemas.GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData (Total Keys: 20) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.agentConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunMetric.properties.metricConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1FunctionResponse.properties.parts (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1FunctionResponseBlob (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1FunctionResponseFileData (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1FunctionResponsePart (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest.properties.agentConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectMemoriesSourceDirectMemory.properties.topics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ImageConfig.properties.imageOutputOptions.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ImageConfig.properties.personGeneration.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1IntermediateExtractedMemory (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1Memory.properties.topics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Metric.properties.customCodeExecutionSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1OptimizePromptRequest.properties.optimizationTarget.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PredictRequest.properties.labels (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1RagCorpus.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.agentCard (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.sourceCodeSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec (Total Keys: 14) - schemas.GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest.properties.filter.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1RollbackMemoryRequest (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1Tool.properties.computerUse.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ToolComputerUse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1UsageMetadata (Total Keys: 31) The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/aiplatform_v1.customJobs.html | 91 + .../aiplatform_v1.customJobs.operations.html | 272 + docs/dyn/aiplatform_v1.dataLabelingJobs.html | 91 + ...atform_v1.dataLabelingJobs.operations.html | 272 + ...iplatform_v1.datasets.annotationSpecs.html | 91 + ...1.datasets.annotationSpecs.operations.html | 272 + ...orm_v1.datasets.dataItems.annotations.html | 91 + ...sets.dataItems.annotations.operations.html | 272 + .../dyn/aiplatform_v1.datasets.dataItems.html | 96 + ...form_v1.datasets.dataItems.operations.html | 272 + docs/dyn/aiplatform_v1.datasets.html | 20 + .../aiplatform_v1.datasets.operations.html | 272 + .../aiplatform_v1.datasets.savedQueries.html | 91 + ...m_v1.datasets.savedQueries.operations.html | 272 + ...aiplatform_v1.deploymentResourcePools.html | 91 + ...v1.deploymentResourcePools.operations.html | 272 + docs/dyn/aiplatform_v1.endpoints.html | 1159 +- .../aiplatform_v1.endpoints.operations.html | 272 + .../aiplatform_v1.featureGroups.features.html | 91 + ..._v1.featureGroups.features.operations.html | 251 + docs/dyn/aiplatform_v1.featureGroups.html | 96 + ...iplatform_v1.featureGroups.operations.html | 251 + ...m_v1.featureOnlineStores.featureViews.html | 91 + ...eOnlineStores.featureViews.operations.html | 251 + .../aiplatform_v1.featureOnlineStores.html | 96 + ...orm_v1.featureOnlineStores.operations.html | 251 + ...v1.featurestores.entityTypes.features.html | 91 + ...tores.entityTypes.features.operations.html | 272 + ...platform_v1.featurestores.entityTypes.html | 96 + ....featurestores.entityTypes.operations.html | 272 + docs/dyn/aiplatform_v1.featurestores.html | 96 + ...iplatform_v1.featurestores.operations.html | 272 + docs/dyn/aiplatform_v1.html | 135 + ...iplatform_v1.hyperparameterTuningJobs.html | 91 + ...1.hyperparameterTuningJobs.operations.html | 272 + docs/dyn/aiplatform_v1.indexEndpoints.html | 91 + ...platform_v1.indexEndpoints.operations.html | 272 + docs/dyn/aiplatform_v1.indexes.html | 91 + .../dyn/aiplatform_v1.indexes.operations.html | 272 + ...iplatform_v1.metadataStores.artifacts.html | 91 + ...1.metadataStores.artifacts.operations.html | 272 + ...aiplatform_v1.metadataStores.contexts.html | 91 + ...v1.metadataStores.contexts.operations.html | 272 + ...platform_v1.metadataStores.executions.html | 91 + ....metadataStores.executions.operations.html | 272 + docs/dyn/aiplatform_v1.metadataStores.html | 106 + ...platform_v1.metadataStores.operations.html | 272 + .../aiplatform_v1.migratableResources.html | 91 + ...orm_v1.migratableResources.operations.html | 272 + ...form_v1.modelDeploymentMonitoringJobs.html | 91 + ...elDeploymentMonitoringJobs.operations.html | 272 + .../dyn/aiplatform_v1.models.evaluations.html | 91 + ...form_v1.models.evaluations.operations.html | 272 + docs/dyn/aiplatform_v1.models.html | 96 + docs/dyn/aiplatform_v1.models.operations.html | 272 + .../aiplatform_v1.notebookExecutionJobs.html | 91 + ...m_v1.notebookExecutionJobs.operations.html | 272 + ...iplatform_v1.notebookRuntimeTemplates.html | 91 + ...1.notebookRuntimeTemplates.operations.html | 272 + docs/dyn/aiplatform_v1.notebookRuntimes.html | 91 + ...atform_v1.notebookRuntimes.operations.html | 272 + docs/dyn/aiplatform_v1.operations.html | 272 + .../aiplatform_v1.persistentResources.html | 91 + ...orm_v1.persistentResources.operations.html | 272 + docs/dyn/aiplatform_v1.pipelineJobs.html | 91 + ...aiplatform_v1.pipelineJobs.operations.html | 272 + ..._v1.projects.locations.cachedContents.html | 636 +- ...tform_v1.projects.locations.endpoints.html | 1156 +- ...v1.projects.locations.evaluationItems.html | 400 +- ..._v1.projects.locations.evaluationRuns.html | 3362 +- .../dyn/aiplatform_v1.projects.locations.html | 2054 +- ....projects.locations.publishers.models.html | 1283 +- ...form_v1.projects.locations.ragCorpora.html | 8 + ...1.projects.locations.reasoningEngines.html | 52 +- ...form_v1.projects.locations.tuningJobs.html | 1325 +- docs/dyn/aiplatform_v1.publishers.models.html | 1154 +- docs/dyn/aiplatform_v1.ragCorpora.html | 96 + .../aiplatform_v1.ragCorpora.operations.html | 272 + .../aiplatform_v1.ragCorpora.ragFiles.html | 91 + ...orm_v1.ragCorpora.ragFiles.operations.html | 272 + docs/dyn/aiplatform_v1.ragEngineConfig.html | 91 + ...latform_v1.ragEngineConfig.operations.html | 272 + docs/dyn/aiplatform_v1.reasoningEngines.html | 57 +- ...atform_v1.reasoningEngines.operations.html | 272 + docs/dyn/aiplatform_v1.schedules.html | 91 + .../aiplatform_v1.schedules.operations.html | 272 + docs/dyn/aiplatform_v1.specialistPools.html | 91 + ...latform_v1.specialistPools.operations.html | 272 + docs/dyn/aiplatform_v1.studies.html | 96 + .../dyn/aiplatform_v1.studies.operations.html | 272 + docs/dyn/aiplatform_v1.studies.trials.html | 91 + ...platform_v1.studies.trials.operations.html | 272 + ...iplatform_v1.tensorboards.experiments.html | 96 + ...1.tensorboards.experiments.operations.html | 272 + ...form_v1.tensorboards.experiments.runs.html | 96 + ...sorboards.experiments.runs.operations.html | 272 + ...sorboards.experiments.runs.timeSeries.html | 91 + ...xperiments.runs.timeSeries.operations.html | 272 + docs/dyn/aiplatform_v1.tensorboards.html | 96 + ...aiplatform_v1.tensorboards.operations.html | 272 + docs/dyn/aiplatform_v1.trainingPipelines.html | 91 + ...tform_v1.trainingPipelines.operations.html | 272 + docs/dyn/aiplatform_v1.tuningJobs.html | 91 + .../aiplatform_v1.tuningJobs.operations.html | 233 + docs/dyn/aiplatform_v1beta1.agents.html | 91 + .../aiplatform_v1beta1.agents.operations.html | 272 + docs/dyn/aiplatform_v1beta1.apps.html | 91 + .../aiplatform_v1beta1.apps.operations.html | 272 + docs/dyn/aiplatform_v1beta1.customJobs.html | 91 + ...latform_v1beta1.customJobs.operations.html | 272 + .../aiplatform_v1beta1.dataLabelingJobs.html | 91 + ...m_v1beta1.dataLabelingJobs.operations.html | 272 + ...form_v1beta1.datasets.annotationSpecs.html | 91 + ...1.datasets.annotationSpecs.operations.html | 272 + ...1beta1.datasets.dataItems.annotations.html | 91 + ...sets.dataItems.annotations.operations.html | 272 + ...aiplatform_v1beta1.datasets.dataItems.html | 96 + ...v1beta1.datasets.dataItems.operations.html | 272 + docs/dyn/aiplatform_v1beta1.datasets.html | 20 + ...iplatform_v1beta1.datasets.operations.html | 272 + ...latform_v1beta1.datasets.savedQueries.html | 91 + ...eta1.datasets.savedQueries.operations.html | 272 + ...tform_v1beta1.deploymentResourcePools.html | 91 + ...a1.deploymentResourcePools.operations.html | 272 + docs/dyn/aiplatform_v1beta1.edgeDevices.html | 91 + ...atform_v1beta1.edgeDevices.operations.html | 272 + docs/dyn/aiplatform_v1beta1.endpoints.html | 1163 +- ...platform_v1beta1.endpoints.operations.html | 272 + .../aiplatform_v1beta1.evaluationItems.html | 91 + ...rm_v1beta1.evaluationItems.operations.html | 251 + .../aiplatform_v1beta1.evaluationRuns.html | 91 + ...orm_v1beta1.evaluationRuns.operations.html | 251 + .../aiplatform_v1beta1.evaluationSets.html | 91 + ...orm_v1beta1.evaluationSets.operations.html | 251 + .../aiplatform_v1beta1.evaluationTasks.html | 91 + ...rm_v1beta1.evaluationTasks.operations.html | 251 + .../dyn/aiplatform_v1beta1.exampleStores.html | 91 + ...form_v1beta1.exampleStores.operations.html | 272 + ...platform_v1beta1.extensionControllers.html | 91 + ...beta1.extensionControllers.operations.html | 272 + docs/dyn/aiplatform_v1beta1.extensions.html | 91 + ...latform_v1beta1.extensions.operations.html | 272 + ...v1beta1.featureGroups.featureMonitors.html | 91 + ...tureGroups.featureMonitors.operations.html | 251 + ...atform_v1beta1.featureGroups.features.html | 91 + ...ta1.featureGroups.features.operations.html | 251 + .../dyn/aiplatform_v1beta1.featureGroups.html | 101 + ...form_v1beta1.featureGroups.operations.html | 251 + ...eta1.featureOnlineStores.featureViews.html | 91 + ...eOnlineStores.featureViews.operations.html | 251 + ...iplatform_v1beta1.featureOnlineStores.html | 96 + ...1beta1.featureOnlineStores.operations.html | 251 + ...a1.featurestores.entityTypes.features.html | 91 + ...tores.entityTypes.features.operations.html | 272 + ...orm_v1beta1.featurestores.entityTypes.html | 96 + ....featurestores.entityTypes.operations.html | 272 + .../dyn/aiplatform_v1beta1.featurestores.html | 96 + ...form_v1beta1.featurestores.operations.html | 272 + docs/dyn/aiplatform_v1beta1.html | 195 + ...form_v1beta1.hyperparameterTuningJobs.html | 91 + ...1.hyperparameterTuningJobs.operations.html | 272 + .../aiplatform_v1beta1.indexEndpoints.html | 91 + ...orm_v1beta1.indexEndpoints.operations.html | 272 + docs/dyn/aiplatform_v1beta1.indexes.html | 91 + ...aiplatform_v1beta1.indexes.operations.html | 272 + ...form_v1beta1.metadataStores.artifacts.html | 91 + ...1.metadataStores.artifacts.operations.html | 272 + ...tform_v1beta1.metadataStores.contexts.html | 91 + ...a1.metadataStores.contexts.operations.html | 272 + ...orm_v1beta1.metadataStores.executions.html | 91 + ....metadataStores.executions.operations.html | 272 + .../aiplatform_v1beta1.metadataStores.html | 106 + ...orm_v1beta1.metadataStores.operations.html | 272 + ...iplatform_v1beta1.migratableResources.html | 91 + ...1beta1.migratableResources.operations.html | 272 + ...v1beta1.modelDeploymentMonitoringJobs.html | 91 + ...elDeploymentMonitoringJobs.operations.html | 272 + .../dyn/aiplatform_v1beta1.modelMonitors.html | 91 + ...form_v1beta1.modelMonitors.operations.html | 272 + ...aiplatform_v1beta1.models.evaluations.html | 91 + ...v1beta1.models.evaluations.operations.html | 272 + docs/dyn/aiplatform_v1beta1.models.html | 96 + .../aiplatform_v1beta1.models.operations.html | 272 + ...latform_v1beta1.notebookExecutionJobs.html | 91 + ...eta1.notebookExecutionJobs.operations.html | 272 + ...form_v1beta1.notebookRuntimeTemplates.html | 91 + ...1.notebookRuntimeTemplates.operations.html | 272 + .../aiplatform_v1beta1.notebookRuntimes.html | 91 + ...m_v1beta1.notebookRuntimes.operations.html | 272 + docs/dyn/aiplatform_v1beta1.operations.html | 272 + ...iplatform_v1beta1.persistentResources.html | 91 + ...1beta1.persistentResources.operations.html | 272 + docs/dyn/aiplatform_v1beta1.pipelineJobs.html | 91 + ...tform_v1beta1.pipelineJobs.operations.html | 272 + ...ta1.projects.locations.cachedContents.html | 636 +- ...m_v1beta1.projects.locations.datasets.html | 386 +- ...cts.locations.deploymentResourcePools.html | 10 +- ..._v1beta1.projects.locations.endpoints.html | 1176 +- ...a1.projects.locations.evaluationItems.html | 1408 +- ...ta1.projects.locations.evaluationRuns.html | 5092 ++- ...eta1.projects.locations.exampleStores.html | 450 +- ...v1beta1.projects.locations.extensions.html | 100 +- ...aiplatform_v1beta1.projects.locations.html | 2091 +- ...ta1.projects.locations.indexEndpoints.html | 14 +- ....projects.locations.publishers.models.html | 1289 +- ...v1beta1.projects.locations.ragCorpora.html | 8 + ...1.projects.locations.reasoningEngines.html | 272 +- ...s.locations.reasoningEngines.memories.html | 173 +- ...s.reasoningEngines.memories.revisions.html | 177 + ...ions.reasoningEngines.sessions.events.html | 144 +- ...s.locations.reasoningEngines.sessions.html | 141 +- ...v1beta1.projects.locations.tuningJobs.html | 5102 +-- .../aiplatform_v1beta1.publishers.models.html | 1166 +- docs/dyn/aiplatform_v1beta1.ragCorpora.html | 96 + ...latform_v1beta1.ragCorpora.operations.html | 272 + ...iplatform_v1beta1.ragCorpora.ragFiles.html | 91 + ...1beta1.ragCorpora.ragFiles.operations.html | 272 + .../aiplatform_v1beta1.ragEngineConfig.html | 91 + ...rm_v1beta1.ragEngineConfig.operations.html | 272 + ...orm_v1beta1.reasoningEngines.examples.html | 91 + ....reasoningEngines.examples.operations.html | 205 + .../aiplatform_v1beta1.reasoningEngines.html | 287 +- ...orm_v1beta1.reasoningEngines.memories.html | 178 +- ....reasoningEngines.memories.operations.html | 272 + ...1.reasoningEngines.memories.revisions.html | 177 + ...m_v1beta1.reasoningEngines.operations.html | 272 + ....reasoningEngines.sandboxEnvironments.html | 349 + ...ngines.sandboxEnvironments.operations.html | 272 + ...eta1.reasoningEngines.sessions.events.html | 144 +- ...orm_v1beta1.reasoningEngines.sessions.html | 146 +- ....reasoningEngines.sessions.operations.html | 272 + docs/dyn/aiplatform_v1beta1.schedules.html | 91 + ...platform_v1beta1.schedules.operations.html | 272 + docs/dyn/aiplatform_v1beta1.solvers.html | 91 + ...aiplatform_v1beta1.solvers.operations.html | 212 + .../aiplatform_v1beta1.specialistPools.html | 91 + ...rm_v1beta1.specialistPools.operations.html | 272 + docs/dyn/aiplatform_v1beta1.studies.html | 96 + ...aiplatform_v1beta1.studies.operations.html | 272 + .../aiplatform_v1beta1.studies.trials.html | 91 + ...orm_v1beta1.studies.trials.operations.html | 272 + ...form_v1beta1.tensorboards.experiments.html | 96 + ...1.tensorboards.experiments.operations.html | 272 + ...v1beta1.tensorboards.experiments.runs.html | 96 + ...sorboards.experiments.runs.operations.html | 272 + ...sorboards.experiments.runs.timeSeries.html | 91 + ...xperiments.runs.timeSeries.operations.html | 272 + docs/dyn/aiplatform_v1beta1.tensorboards.html | 96 + ...tform_v1beta1.tensorboards.operations.html | 272 + .../aiplatform_v1beta1.trainingPipelines.html | 91 + ..._v1beta1.trainingPipelines.operations.html | 272 + docs/dyn/aiplatform_v1beta1.tuningJobs.html | 91 + ...latform_v1beta1.tuningJobs.operations.html | 107 + .../documents/aiplatform.v1.json | 23556 +++++++---- .../documents/aiplatform.v1beta1.json | 32122 +++++++++++----- 255 files changed, 99180 insertions(+), 30626 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.customJobs.html create mode 100644 docs/dyn/aiplatform_v1.customJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1.dataLabelingJobs.html create mode 100644 docs/dyn/aiplatform_v1.dataLabelingJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1.datasets.annotationSpecs.html create mode 100644 docs/dyn/aiplatform_v1.datasets.annotationSpecs.operations.html create mode 100644 docs/dyn/aiplatform_v1.datasets.dataItems.annotations.html create mode 100644 docs/dyn/aiplatform_v1.datasets.dataItems.annotations.operations.html create mode 100644 docs/dyn/aiplatform_v1.datasets.dataItems.html create mode 100644 docs/dyn/aiplatform_v1.datasets.dataItems.operations.html create mode 100644 docs/dyn/aiplatform_v1.datasets.operations.html create mode 100644 docs/dyn/aiplatform_v1.datasets.savedQueries.html create mode 100644 docs/dyn/aiplatform_v1.datasets.savedQueries.operations.html create mode 100644 docs/dyn/aiplatform_v1.deploymentResourcePools.html create mode 100644 docs/dyn/aiplatform_v1.deploymentResourcePools.operations.html create mode 100644 docs/dyn/aiplatform_v1.endpoints.operations.html create mode 100644 docs/dyn/aiplatform_v1.featureGroups.features.html create mode 100644 docs/dyn/aiplatform_v1.featureGroups.features.operations.html create mode 100644 docs/dyn/aiplatform_v1.featureGroups.html create mode 100644 docs/dyn/aiplatform_v1.featureGroups.operations.html create mode 100644 docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.html create mode 100644 docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.operations.html create mode 100644 docs/dyn/aiplatform_v1.featureOnlineStores.html create mode 100644 docs/dyn/aiplatform_v1.featureOnlineStores.operations.html create mode 100644 docs/dyn/aiplatform_v1.featurestores.entityTypes.features.html create mode 100644 docs/dyn/aiplatform_v1.featurestores.entityTypes.features.operations.html create mode 100644 docs/dyn/aiplatform_v1.featurestores.entityTypes.html create mode 100644 docs/dyn/aiplatform_v1.featurestores.entityTypes.operations.html create mode 100644 docs/dyn/aiplatform_v1.featurestores.html create mode 100644 docs/dyn/aiplatform_v1.featurestores.operations.html create mode 100644 docs/dyn/aiplatform_v1.hyperparameterTuningJobs.html create mode 100644 docs/dyn/aiplatform_v1.hyperparameterTuningJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1.indexEndpoints.html create mode 100644 docs/dyn/aiplatform_v1.indexEndpoints.operations.html create mode 100644 docs/dyn/aiplatform_v1.indexes.html create mode 100644 docs/dyn/aiplatform_v1.indexes.operations.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.artifacts.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.artifacts.operations.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.contexts.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.contexts.operations.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.executions.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.executions.operations.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.html create mode 100644 docs/dyn/aiplatform_v1.metadataStores.operations.html create mode 100644 docs/dyn/aiplatform_v1.migratableResources.html create mode 100644 docs/dyn/aiplatform_v1.migratableResources.operations.html create mode 100644 docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.html create mode 100644 docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1.models.evaluations.html create mode 100644 docs/dyn/aiplatform_v1.models.evaluations.operations.html create mode 100644 docs/dyn/aiplatform_v1.models.html create mode 100644 docs/dyn/aiplatform_v1.models.operations.html create mode 100644 docs/dyn/aiplatform_v1.notebookExecutionJobs.html create mode 100644 docs/dyn/aiplatform_v1.notebookExecutionJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1.notebookRuntimeTemplates.html create mode 100644 docs/dyn/aiplatform_v1.notebookRuntimeTemplates.operations.html create mode 100644 docs/dyn/aiplatform_v1.notebookRuntimes.html create mode 100644 docs/dyn/aiplatform_v1.notebookRuntimes.operations.html create mode 100644 docs/dyn/aiplatform_v1.operations.html create mode 100644 docs/dyn/aiplatform_v1.persistentResources.html create mode 100644 docs/dyn/aiplatform_v1.persistentResources.operations.html create mode 100644 docs/dyn/aiplatform_v1.pipelineJobs.html create mode 100644 docs/dyn/aiplatform_v1.pipelineJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1.ragCorpora.html create mode 100644 docs/dyn/aiplatform_v1.ragCorpora.operations.html create mode 100644 docs/dyn/aiplatform_v1.ragCorpora.ragFiles.html create mode 100644 docs/dyn/aiplatform_v1.ragCorpora.ragFiles.operations.html create mode 100644 docs/dyn/aiplatform_v1.ragEngineConfig.html create mode 100644 docs/dyn/aiplatform_v1.ragEngineConfig.operations.html create mode 100644 docs/dyn/aiplatform_v1.reasoningEngines.operations.html create mode 100644 docs/dyn/aiplatform_v1.schedules.html create mode 100644 docs/dyn/aiplatform_v1.schedules.operations.html create mode 100644 docs/dyn/aiplatform_v1.specialistPools.html create mode 100644 docs/dyn/aiplatform_v1.specialistPools.operations.html create mode 100644 docs/dyn/aiplatform_v1.studies.html create mode 100644 docs/dyn/aiplatform_v1.studies.operations.html create mode 100644 docs/dyn/aiplatform_v1.studies.trials.html create mode 100644 docs/dyn/aiplatform_v1.studies.trials.operations.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.experiments.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.experiments.operations.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.experiments.runs.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.experiments.runs.operations.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.operations.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.html create mode 100644 docs/dyn/aiplatform_v1.tensorboards.operations.html create mode 100644 docs/dyn/aiplatform_v1.trainingPipelines.html create mode 100644 docs/dyn/aiplatform_v1.trainingPipelines.operations.html create mode 100644 docs/dyn/aiplatform_v1.tuningJobs.html create mode 100644 docs/dyn/aiplatform_v1.tuningJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.agents.html create mode 100644 docs/dyn/aiplatform_v1beta1.agents.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.apps.html create mode 100644 docs/dyn/aiplatform_v1beta1.apps.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.customJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.customJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.dataLabelingJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.dataLabelingJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.dataItems.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.dataItems.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.savedQueries.html create mode 100644 docs/dyn/aiplatform_v1beta1.datasets.savedQueries.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.deploymentResourcePools.html create mode 100644 docs/dyn/aiplatform_v1beta1.deploymentResourcePools.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.edgeDevices.html create mode 100644 docs/dyn/aiplatform_v1beta1.edgeDevices.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.endpoints.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationItems.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationItems.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationRuns.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationRuns.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationSets.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationSets.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationTasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.evaluationTasks.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.exampleStores.html create mode 100644 docs/dyn/aiplatform_v1beta1.exampleStores.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.extensionControllers.html create mode 100644 docs/dyn/aiplatform_v1beta1.extensionControllers.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.extensions.html create mode 100644 docs/dyn/aiplatform_v1beta1.extensions.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureGroups.features.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureGroups.features.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureGroups.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureGroups.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureOnlineStores.html create mode 100644 docs/dyn/aiplatform_v1beta1.featureOnlineStores.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.html create mode 100644 docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.html create mode 100644 docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.featurestores.html create mode 100644 docs/dyn/aiplatform_v1beta1.featurestores.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.indexEndpoints.html create mode 100644 docs/dyn/aiplatform_v1beta1.indexEndpoints.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.indexes.html create mode 100644 docs/dyn/aiplatform_v1beta1.indexes.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.contexts.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.contexts.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.executions.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.executions.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.html create mode 100644 docs/dyn/aiplatform_v1beta1.metadataStores.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.migratableResources.html create mode 100644 docs/dyn/aiplatform_v1beta1.migratableResources.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.modelMonitors.html create mode 100644 docs/dyn/aiplatform_v1beta1.modelMonitors.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.models.evaluations.html create mode 100644 docs/dyn/aiplatform_v1beta1.models.evaluations.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.models.html create mode 100644 docs/dyn/aiplatform_v1beta1.models.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.html create mode 100644 docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.notebookRuntimes.html create mode 100644 docs/dyn/aiplatform_v1beta1.notebookRuntimes.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.persistentResources.html create mode 100644 docs/dyn/aiplatform_v1beta1.persistentResources.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.pipelineJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.pipelineJobs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html create mode 100644 docs/dyn/aiplatform_v1beta1.ragCorpora.html create mode 100644 docs/dyn/aiplatform_v1beta1.ragCorpora.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.html create mode 100644 docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.ragEngineConfig.html create mode 100644 docs/dyn/aiplatform_v1beta1.ragEngineConfig.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.schedules.html create mode 100644 docs/dyn/aiplatform_v1beta1.schedules.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.solvers.html create mode 100644 docs/dyn/aiplatform_v1beta1.solvers.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.specialistPools.html create mode 100644 docs/dyn/aiplatform_v1beta1.specialistPools.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.studies.html create mode 100644 docs/dyn/aiplatform_v1beta1.studies.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.studies.trials.html create mode 100644 docs/dyn/aiplatform_v1beta1.studies.trials.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.experiments.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.experiments.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.html create mode 100644 docs/dyn/aiplatform_v1beta1.tensorboards.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.trainingPipelines.html create mode 100644 docs/dyn/aiplatform_v1beta1.trainingPipelines.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.tuningJobs.html create mode 100644 docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html diff --git a/docs/dyn/aiplatform_v1.customJobs.html b/docs/dyn/aiplatform_v1.customJobs.html new file mode 100644 index 0000000000..3c5e9a7358 --- /dev/null +++ b/docs/dyn/aiplatform_v1.customJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . customJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.customJobs.operations.html b/docs/dyn/aiplatform_v1.customJobs.operations.html new file mode 100644 index 0000000000..a0357b93a7 --- /dev/null +++ b/docs/dyn/aiplatform_v1.customJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . customJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.dataLabelingJobs.html b/docs/dyn/aiplatform_v1.dataLabelingJobs.html new file mode 100644 index 0000000000..6b46398959 --- /dev/null +++ b/docs/dyn/aiplatform_v1.dataLabelingJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . dataLabelingJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.dataLabelingJobs.operations.html b/docs/dyn/aiplatform_v1.dataLabelingJobs.operations.html new file mode 100644 index 0000000000..cd07728d9c --- /dev/null +++ b/docs/dyn/aiplatform_v1.dataLabelingJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . dataLabelingJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.annotationSpecs.html b/docs/dyn/aiplatform_v1.datasets.annotationSpecs.html new file mode 100644 index 0000000000..5f25532596 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.annotationSpecs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . datasets . annotationSpecs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.annotationSpecs.operations.html b/docs/dyn/aiplatform_v1.datasets.annotationSpecs.operations.html new file mode 100644 index 0000000000..fe3a4a9961 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.annotationSpecs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . annotationSpecs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.dataItems.annotations.html b/docs/dyn/aiplatform_v1.datasets.dataItems.annotations.html new file mode 100644 index 0000000000..b328716b25 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.dataItems.annotations.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . datasets . dataItems . annotations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.dataItems.annotations.operations.html b/docs/dyn/aiplatform_v1.datasets.dataItems.annotations.operations.html new file mode 100644 index 0000000000..308ff74283 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.dataItems.annotations.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . dataItems . annotations . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.dataItems.html b/docs/dyn/aiplatform_v1.datasets.dataItems.html new file mode 100644 index 0000000000..4c3ffcccb1 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.dataItems.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . datasets . dataItems

+

Instance Methods

+

+ annotations() +

+

Returns the annotations Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.dataItems.operations.html b/docs/dyn/aiplatform_v1.datasets.dataItems.operations.html new file mode 100644 index 0000000000..36407a5d08 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.dataItems.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . dataItems . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.html b/docs/dyn/aiplatform_v1.datasets.html index 1e65389981..b10de1eff3 100644 --- a/docs/dyn/aiplatform_v1.datasets.html +++ b/docs/dyn/aiplatform_v1.datasets.html @@ -74,11 +74,31 @@

Vertex AI API . datasets

Instance Methods

+

+ annotationSpecs() +

+

Returns the annotationSpecs Resource.

+ +

+ dataItems() +

+

Returns the dataItems Resource.

+

datasetVersions()

Returns the datasetVersions Resource.

+

+ operations() +

+

Returns the operations Resource.

+ +

+ savedQueries() +

+

Returns the savedQueries Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1.datasets.operations.html b/docs/dyn/aiplatform_v1.datasets.operations.html new file mode 100644 index 0000000000..86484aaf55 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.savedQueries.html b/docs/dyn/aiplatform_v1.datasets.savedQueries.html new file mode 100644 index 0000000000..c9432ba9a9 --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.savedQueries.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . datasets . savedQueries

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.datasets.savedQueries.operations.html b/docs/dyn/aiplatform_v1.datasets.savedQueries.operations.html new file mode 100644 index 0000000000..a0469982ea --- /dev/null +++ b/docs/dyn/aiplatform_v1.datasets.savedQueries.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . savedQueries . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.deploymentResourcePools.html b/docs/dyn/aiplatform_v1.deploymentResourcePools.html new file mode 100644 index 0000000000..940295cc9a --- /dev/null +++ b/docs/dyn/aiplatform_v1.deploymentResourcePools.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . deploymentResourcePools

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.deploymentResourcePools.operations.html b/docs/dyn/aiplatform_v1.deploymentResourcePools.operations.html new file mode 100644 index 0000000000..a51b906ff0 --- /dev/null +++ b/docs/dyn/aiplatform_v1.deploymentResourcePools.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . deploymentResourcePools . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 054d0015e6..f50f3acd5f 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -79,6 +79,11 @@

Instance Methods

Returns the chat Resource.

+

+ operations() +

+

Returns the operations Resource.

+

close()

Close httplib2 connections.

@@ -120,50 +125,64 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -206,71 +225,90 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -309,99 +347,119 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -608,9 +666,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -672,71 +730,90 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -775,104 +852,118 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -893,6 +984,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1100,179 +1197,193 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -1284,46 +1395,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -1345,6 +1456,9 @@

Method Details

"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. "", ], + "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + "a_key": "A String", + }, "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. } @@ -1425,71 +1539,90 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1528,104 +1661,118 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1646,6 +1793,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1853,179 +2006,193 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -2037,46 +2204,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. diff --git a/docs/dyn/aiplatform_v1.endpoints.operations.html b/docs/dyn/aiplatform_v1.endpoints.operations.html new file mode 100644 index 0000000000..e0bca70271 --- /dev/null +++ b/docs/dyn/aiplatform_v1.endpoints.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . endpoints . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureGroups.features.html b/docs/dyn/aiplatform_v1.featureGroups.features.html new file mode 100644 index 0000000000..fca96cb703 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureGroups.features.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featureGroups . features

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureGroups.features.operations.html b/docs/dyn/aiplatform_v1.featureGroups.features.operations.html new file mode 100644 index 0000000000..32f8aca873 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureGroups.features.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureGroups . features . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ listWait_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ listWait_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureGroups.html b/docs/dyn/aiplatform_v1.featureGroups.html new file mode 100644 index 0000000000..e27c140d84 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureGroups.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featureGroups

+

Instance Methods

+

+ features() +

+

Returns the features Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureGroups.operations.html b/docs/dyn/aiplatform_v1.featureGroups.operations.html new file mode 100644 index 0000000000..992e7ae742 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureGroups.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureGroups . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ listWait_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ listWait_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.html new file mode 100644 index 0000000000..b69c377de0 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featureOnlineStores . featureViews

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.operations.html b/docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.operations.html new file mode 100644 index 0000000000..7ca7b2aca9 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureOnlineStores.featureViews.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureOnlineStores . featureViews . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ listWait_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ listWait_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureOnlineStores.html b/docs/dyn/aiplatform_v1.featureOnlineStores.html new file mode 100644 index 0000000000..dbf4700ac3 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureOnlineStores.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featureOnlineStores

+

Instance Methods

+

+ featureViews() +

+

Returns the featureViews Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featureOnlineStores.operations.html b/docs/dyn/aiplatform_v1.featureOnlineStores.operations.html new file mode 100644 index 0000000000..f99d8a328d --- /dev/null +++ b/docs/dyn/aiplatform_v1.featureOnlineStores.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureOnlineStores . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ listWait_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ listWait(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ listWait_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featurestores.entityTypes.features.html b/docs/dyn/aiplatform_v1.featurestores.entityTypes.features.html new file mode 100644 index 0000000000..132d55775c --- /dev/null +++ b/docs/dyn/aiplatform_v1.featurestores.entityTypes.features.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featurestores . entityTypes . features

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featurestores.entityTypes.features.operations.html b/docs/dyn/aiplatform_v1.featurestores.entityTypes.features.operations.html new file mode 100644 index 0000000000..bb5bd5c6d4 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featurestores.entityTypes.features.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . featurestores . entityTypes . features . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featurestores.entityTypes.html b/docs/dyn/aiplatform_v1.featurestores.entityTypes.html new file mode 100644 index 0000000000..c6349b835d --- /dev/null +++ b/docs/dyn/aiplatform_v1.featurestores.entityTypes.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featurestores . entityTypes

+

Instance Methods

+

+ features() +

+

Returns the features Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featurestores.entityTypes.operations.html b/docs/dyn/aiplatform_v1.featurestores.entityTypes.operations.html new file mode 100644 index 0000000000..f7942d877c --- /dev/null +++ b/docs/dyn/aiplatform_v1.featurestores.entityTypes.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . featurestores . entityTypes . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featurestores.html b/docs/dyn/aiplatform_v1.featurestores.html new file mode 100644 index 0000000000..90c7a1e1dc --- /dev/null +++ b/docs/dyn/aiplatform_v1.featurestores.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featurestores

+

Instance Methods

+

+ entityTypes() +

+

Returns the entityTypes Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.featurestores.operations.html b/docs/dyn/aiplatform_v1.featurestores.operations.html new file mode 100644 index 0000000000..6403d7f752 --- /dev/null +++ b/docs/dyn/aiplatform_v1.featurestores.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . featurestores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.html b/docs/dyn/aiplatform_v1.html index 3d7926dcee..f7ddd2c35f 100644 --- a/docs/dyn/aiplatform_v1.html +++ b/docs/dyn/aiplatform_v1.html @@ -79,21 +79,116 @@

Instance Methods

Returns the batchPredictionJobs Resource.

+

+ customJobs() +

+

Returns the customJobs Resource.

+ +

+ dataLabelingJobs() +

+

Returns the dataLabelingJobs Resource.

+

datasets()

Returns the datasets Resource.

+

+ deploymentResourcePools() +

+

Returns the deploymentResourcePools Resource.

+

endpoints()

Returns the endpoints Resource.

+

+ featureGroups() +

+

Returns the featureGroups Resource.

+ +

+ featureOnlineStores() +

+

Returns the featureOnlineStores Resource.

+ +

+ featurestores() +

+

Returns the featurestores Resource.

+ +

+ hyperparameterTuningJobs() +

+

Returns the hyperparameterTuningJobs Resource.

+ +

+ indexEndpoints() +

+

Returns the indexEndpoints Resource.

+ +

+ indexes() +

+

Returns the indexes Resource.

+

media()

Returns the media Resource.

+

+ metadataStores() +

+

Returns the metadataStores Resource.

+ +

+ migratableResources() +

+

Returns the migratableResources Resource.

+ +

+ modelDeploymentMonitoringJobs() +

+

Returns the modelDeploymentMonitoringJobs Resource.

+ +

+ models() +

+

Returns the models Resource.

+ +

+ notebookExecutionJobs() +

+

Returns the notebookExecutionJobs Resource.

+ +

+ notebookRuntimeTemplates() +

+

Returns the notebookRuntimeTemplates Resource.

+ +

+ notebookRuntimes() +

+

Returns the notebookRuntimes Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ persistentResources() +

+

Returns the persistentResources Resource.

+ +

+ pipelineJobs() +

+

Returns the pipelineJobs Resource.

+

projects()

@@ -104,11 +199,51 @@

Instance Methods

Returns the publishers Resource.

+

+ ragCorpora() +

+

Returns the ragCorpora Resource.

+ +

+ ragEngineConfig() +

+

Returns the ragEngineConfig Resource.

+

reasoningEngines()

Returns the reasoningEngines Resource.

+

+ schedules() +

+

Returns the schedules Resource.

+ +

+ specialistPools() +

+

Returns the specialistPools Resource.

+ +

+ studies() +

+

Returns the studies Resource.

+ +

+ tensorboards() +

+

Returns the tensorboards Resource.

+ +

+ trainingPipelines() +

+

Returns the trainingPipelines Resource.

+ +

+ tuningJobs() +

+

Returns the tuningJobs Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.hyperparameterTuningJobs.html new file mode 100644 index 0000000000..3893daf745 --- /dev/null +++ b/docs/dyn/aiplatform_v1.hyperparameterTuningJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . hyperparameterTuningJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.hyperparameterTuningJobs.operations.html b/docs/dyn/aiplatform_v1.hyperparameterTuningJobs.operations.html new file mode 100644 index 0000000000..69bd4d7f6b --- /dev/null +++ b/docs/dyn/aiplatform_v1.hyperparameterTuningJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . hyperparameterTuningJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.indexEndpoints.html b/docs/dyn/aiplatform_v1.indexEndpoints.html new file mode 100644 index 0000000000..a0fe961620 --- /dev/null +++ b/docs/dyn/aiplatform_v1.indexEndpoints.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . indexEndpoints

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.indexEndpoints.operations.html b/docs/dyn/aiplatform_v1.indexEndpoints.operations.html new file mode 100644 index 0000000000..5a698fa6c3 --- /dev/null +++ b/docs/dyn/aiplatform_v1.indexEndpoints.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . indexEndpoints . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.indexes.html b/docs/dyn/aiplatform_v1.indexes.html new file mode 100644 index 0000000000..35f7fe3e71 --- /dev/null +++ b/docs/dyn/aiplatform_v1.indexes.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . indexes

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.indexes.operations.html b/docs/dyn/aiplatform_v1.indexes.operations.html new file mode 100644 index 0000000000..deb4c8bea9 --- /dev/null +++ b/docs/dyn/aiplatform_v1.indexes.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . indexes . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.artifacts.html b/docs/dyn/aiplatform_v1.metadataStores.artifacts.html new file mode 100644 index 0000000000..9c227f5a60 --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.artifacts.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . metadataStores . artifacts

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.artifacts.operations.html b/docs/dyn/aiplatform_v1.metadataStores.artifacts.operations.html new file mode 100644 index 0000000000..660f0bb666 --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.artifacts.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . artifacts . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.contexts.html b/docs/dyn/aiplatform_v1.metadataStores.contexts.html new file mode 100644 index 0000000000..004f77a361 --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.contexts.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . metadataStores . contexts

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.contexts.operations.html b/docs/dyn/aiplatform_v1.metadataStores.contexts.operations.html new file mode 100644 index 0000000000..b76c217ca6 --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.contexts.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . contexts . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.executions.html b/docs/dyn/aiplatform_v1.metadataStores.executions.html new file mode 100644 index 0000000000..29f4a94bfc --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.executions.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . metadataStores . executions

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.executions.operations.html b/docs/dyn/aiplatform_v1.metadataStores.executions.operations.html new file mode 100644 index 0000000000..ea5ebd1b9b --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.executions.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . executions . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.html b/docs/dyn/aiplatform_v1.metadataStores.html new file mode 100644 index 0000000000..88e78bc25a --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.html @@ -0,0 +1,106 @@ + + + +

Vertex AI API . metadataStores

+

Instance Methods

+

+ artifacts() +

+

Returns the artifacts Resource.

+ +

+ contexts() +

+

Returns the contexts Resource.

+ +

+ executions() +

+

Returns the executions Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.metadataStores.operations.html b/docs/dyn/aiplatform_v1.metadataStores.operations.html new file mode 100644 index 0000000000..96e652feab --- /dev/null +++ b/docs/dyn/aiplatform_v1.metadataStores.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.migratableResources.html b/docs/dyn/aiplatform_v1.migratableResources.html new file mode 100644 index 0000000000..81e4791dad --- /dev/null +++ b/docs/dyn/aiplatform_v1.migratableResources.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . migratableResources

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.migratableResources.operations.html b/docs/dyn/aiplatform_v1.migratableResources.operations.html new file mode 100644 index 0000000000..c7fb8756e0 --- /dev/null +++ b/docs/dyn/aiplatform_v1.migratableResources.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . migratableResources . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.html b/docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.html new file mode 100644 index 0000000000..0a13d4a5e6 --- /dev/null +++ b/docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . modelDeploymentMonitoringJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.operations.html b/docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.operations.html new file mode 100644 index 0000000000..96556177f0 --- /dev/null +++ b/docs/dyn/aiplatform_v1.modelDeploymentMonitoringJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . modelDeploymentMonitoringJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.models.evaluations.html b/docs/dyn/aiplatform_v1.models.evaluations.html new file mode 100644 index 0000000000..30f7d5cf48 --- /dev/null +++ b/docs/dyn/aiplatform_v1.models.evaluations.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . models . evaluations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.models.evaluations.operations.html b/docs/dyn/aiplatform_v1.models.evaluations.operations.html new file mode 100644 index 0000000000..4f2aba0d43 --- /dev/null +++ b/docs/dyn/aiplatform_v1.models.evaluations.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . models . evaluations . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.models.html b/docs/dyn/aiplatform_v1.models.html new file mode 100644 index 0000000000..d483717349 --- /dev/null +++ b/docs/dyn/aiplatform_v1.models.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . models

+

Instance Methods

+

+ evaluations() +

+

Returns the evaluations Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.models.operations.html b/docs/dyn/aiplatform_v1.models.operations.html new file mode 100644 index 0000000000..10195a1fa7 --- /dev/null +++ b/docs/dyn/aiplatform_v1.models.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . models . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.notebookExecutionJobs.html new file mode 100644 index 0000000000..0a0482f3dd --- /dev/null +++ b/docs/dyn/aiplatform_v1.notebookExecutionJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . notebookExecutionJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.notebookExecutionJobs.operations.html b/docs/dyn/aiplatform_v1.notebookExecutionJobs.operations.html new file mode 100644 index 0000000000..e5388ed027 --- /dev/null +++ b/docs/dyn/aiplatform_v1.notebookExecutionJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . notebookExecutionJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1.notebookRuntimeTemplates.html new file mode 100644 index 0000000000..d9b2947562 --- /dev/null +++ b/docs/dyn/aiplatform_v1.notebookRuntimeTemplates.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . notebookRuntimeTemplates

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.notebookRuntimeTemplates.operations.html b/docs/dyn/aiplatform_v1.notebookRuntimeTemplates.operations.html new file mode 100644 index 0000000000..0f65387abf --- /dev/null +++ b/docs/dyn/aiplatform_v1.notebookRuntimeTemplates.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . notebookRuntimeTemplates . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.notebookRuntimes.html b/docs/dyn/aiplatform_v1.notebookRuntimes.html new file mode 100644 index 0000000000..07c45a6395 --- /dev/null +++ b/docs/dyn/aiplatform_v1.notebookRuntimes.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . notebookRuntimes

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.notebookRuntimes.operations.html b/docs/dyn/aiplatform_v1.notebookRuntimes.operations.html new file mode 100644 index 0000000000..fa2da22686 --- /dev/null +++ b/docs/dyn/aiplatform_v1.notebookRuntimes.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . notebookRuntimes . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.operations.html b/docs/dyn/aiplatform_v1.operations.html new file mode 100644 index 0000000000..a8a7e83607 --- /dev/null +++ b/docs/dyn/aiplatform_v1.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  filter: string, The standard list filter.
+  name: string, The name of the operation's parent resource.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.persistentResources.html b/docs/dyn/aiplatform_v1.persistentResources.html new file mode 100644 index 0000000000..eb63a926bc --- /dev/null +++ b/docs/dyn/aiplatform_v1.persistentResources.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . persistentResources

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.persistentResources.operations.html b/docs/dyn/aiplatform_v1.persistentResources.operations.html new file mode 100644 index 0000000000..2b2090d656 --- /dev/null +++ b/docs/dyn/aiplatform_v1.persistentResources.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . persistentResources . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.pipelineJobs.html b/docs/dyn/aiplatform_v1.pipelineJobs.html new file mode 100644 index 0000000000..ccf4f48d06 --- /dev/null +++ b/docs/dyn/aiplatform_v1.pipelineJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . pipelineJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.pipelineJobs.operations.html b/docs/dyn/aiplatform_v1.pipelineJobs.operations.html new file mode 100644 index 0000000000..58331782a7 --- /dev/null +++ b/docs/dyn/aiplatform_v1.pipelineJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . pipelineJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index c8b7c3e314..3b69951bfc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -112,50 +112,64 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -166,50 +180,64 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -230,6 +258,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -445,50 +479,64 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -499,50 +547,64 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -563,6 +625,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -803,50 +871,64 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -857,50 +939,64 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -921,6 +1017,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1147,50 +1249,64 @@

Method Details

"cachedContents": [ # List of cached contents. { # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -1201,50 +1317,64 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1265,6 +1395,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1499,50 +1635,64 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -1553,50 +1703,64 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1617,6 +1781,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1833,50 +2003,64 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -1887,50 +2071,64 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1951,6 +2149,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 0e540dd1e4..209d3ab576 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -188,50 +188,64 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -274,71 +288,90 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -377,99 +410,119 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -676,9 +729,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -1634,71 +1687,90 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1737,104 +1809,118 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1855,6 +1941,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -2062,179 +2154,193 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -2246,46 +2352,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -2837,7 +2943,7 @@

Method Details

The object takes the form of: { # Request message for EndpointService.MutateDeployedModel. - "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) + "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only) "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. @@ -3556,6 +3662,9 @@

Method Details

"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. "", ], + "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + "a_key": "A String", + }, "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. } @@ -3864,71 +3973,90 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -3967,104 +4095,118 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -4085,6 +4227,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -4292,179 +4440,193 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -4476,46 +4638,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index f6303d3400..4016cb7228 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -136,50 +136,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -251,50 +265,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -366,50 +394,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -481,50 +523,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -638,50 +694,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -753,50 +823,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -881,50 +965,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -996,50 +1094,64 @@

Method Details

"prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index a7097e7049..1c05bbfd5c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -166,25 +166,30 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -223,45 +228,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -273,25 +278,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -330,45 +340,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -382,25 +392,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -439,45 +454,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -491,6 +506,281 @@

Method Details

"systemInstruction": "A String", # Optional. System instructions for the judge model. }, "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -514,25 +804,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -571,45 +866,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -617,25 +912,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -674,45 +974,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -749,25 +1049,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -806,45 +1111,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -871,25 +1176,30 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -928,45 +1238,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, @@ -1019,25 +1329,30 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1076,45 +1391,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1126,25 +1441,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1183,45 +1503,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1235,25 +1555,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1292,45 +1617,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1344,6 +1669,281 @@

Method Details

"systemInstruction": "A String", # Optional. System instructions for the judge model. }, "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -1367,25 +1967,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1424,45 +2029,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1470,25 +2075,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1527,45 +2137,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1602,25 +2212,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1659,45 +2274,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1724,25 +2339,30 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1781,45 +2401,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, @@ -1914,25 +2534,30 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1971,45 +2596,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2021,25 +2646,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2078,77 +2708,215 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "parameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, }, }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. }, }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # Optional. The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], }, - "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. - "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. - "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - "parameters": { # Optional. The parameters needed to run the pre-defined metric. + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. }, - }, - "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. - "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2187,58 +2955,200 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - "rubricContentType": "A String", # Optional. The type of rubric content to be generated. - "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - "A String", - ], + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. }, - "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - "systemInstruction": "A String", # Optional. System instructions for the judge model. }, - "metric": "A String", # Required. The name of the metric. "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -2262,25 +3172,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2319,45 +3234,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2365,25 +3280,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2422,45 +3342,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2497,25 +3417,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2554,45 +3479,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2619,25 +3544,30 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2676,45 +3606,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, @@ -2780,25 +3710,30 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2837,45 +3772,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2887,25 +3822,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2944,45 +3884,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2996,25 +3936,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -3053,45 +3998,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3105,6 +4050,281 @@

Method Details

"systemInstruction": "A String", # Optional. System instructions for the judge model. }, "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -3128,25 +4348,30 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -3185,45 +4410,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3231,25 +4456,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -3288,45 +4518,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3363,25 +4593,30 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -3420,45 +4655,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3485,25 +4720,30 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -3542,45 +4782,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index 0bada57bfb..016f586f6d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -313,50 +313,64 @@

Method Details

{ # Request message for AugmentPrompt. "contents": [ # Optional. Input content to augment, only text format is supported for now. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "model": { # Metadata of the backend deployed model. # Optional. Metadata of the backend deployed model. @@ -403,50 +417,64 @@

Method Details

{ # Response message for AugmentPrompt. "augmentedPrompt": [ # Augmented prompt, only text format is supported for now. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "facts": [ # Retrieved facts from RAG data sources. @@ -484,50 +512,64 @@

Method Details

The object takes the form of: { # Request message for CorroborateContent. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input content to corroborate, only text format is supported for now. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input content to corroborate, only text format is supported for now. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "facts": [ # Optional. Facts used to generate the text can also be used to corroborate the text. { # The fact used in grounding. @@ -820,25 +862,30 @@

Method Details

"autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.` "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -877,45 +924,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -937,6 +984,9 @@

Method Details

"bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. @@ -946,25 +996,30 @@

Method Details

"judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1003,45 +1058,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1056,25 +1111,30 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1113,45 +1173,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1242,25 +1302,30 @@

Method Details

"autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config used for evaluation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1299,45 +1364,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1409,55 +1474,683 @@

Method Details

}, }, "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. + "agentData": { # Contains data specific to agent evaluations. # Optional. Data used for agent evaluation. + "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. A field containing instructions from the developer for the agent. + "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. + "contents": [ # Optional. Repeated contents. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "text": "A String", # Text data. + }, + "tools": { # Represents a list of tools for an agent. # List of tools. + "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. + }, + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. A field containing instructions from the developer for the agent. + "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. + "contents": [ # Optional. Repeated contents. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "text": "A String", # Text data. + }, + "events": { # Represents a list of events for an agent. # A list of events. + "event": [ # Optional. A list of events. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "eventsText": "A String", # A JSON string containing a sequence of events. + "tools": { # Represents a list of tools for an agent. # List of tools. + "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { "name": "search_actors", "description": "Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.", "parameters": [ { "name": "movie_name", "description": "The name of the movie." }, { "name": "character_name", "description": "The name of the character." } ], "required": ["movie_name", "character_name"] } ] + }, "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. "mapInstance": { # Optional. Map of instance data. "a_key": { # Instance data used to populate placeholders in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1468,50 +2161,64 @@

Method Details

"prompt": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Data used to populate placeholder `prompt` in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1520,50 +2227,64 @@

Method Details

"reference": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Data used to populate placeholder `reference` in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1572,50 +2293,64 @@

Method Details

"response": { # Instance data used to populate placeholders in a metric prompt template. # Required. Data used to populate placeholder `response` in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1648,6 +2383,9 @@

Method Details

"bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. @@ -1657,25 +2395,30 @@

Method Details

"judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1714,45 +2457,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1767,25 +2510,30 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -1824,45 +2572,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1922,50 +2670,64 @@

Method Details

"values": { # Optional. Map of placeholder to contents. "a_key": { # Repeated Content type. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -2015,50 +2777,64 @@

Method Details

"values": { # Optional. Map of placeholder to contents. "a_key": { # Repeated Content type. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -2617,51 +3393,340 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateInstanceRubrics. + "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. A field containing instructions from the developer for the agent. + "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. + "contents": [ # Optional. Repeated contents. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "text": "A String", # Text data. + }, + "tools": { # Represents a list of tools for an agent. # List of tools. + "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. + }, "contents": [ # Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Optional. Specification for using the rubric generation configs of a pre-defined metric, e.g. "generic_quality_v1" and "instruction_following_v1". Some of the configs may be only used in rubric generation and not supporting evaluation, e.g. "fully_customized_generic_quality_v1". If this field is set, the `rubric_generation_spec` field will be ignored. @@ -2674,25 +3739,30 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2731,45 +3801,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2820,50 +3890,64 @@

Method Details

{ # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. "fields": [ # Required. A list of fields that constitute an example. { # Represents a single named field within a SyntheticExample. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the field. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the field. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "fieldName": "A String", # Optional. The name of the field. }, @@ -2895,50 +3979,64 @@

Method Details

{ # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. "fields": [ # Required. A list of fields that constitute an example. { # Represents a single named field within a SyntheticExample. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the field. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the field. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "fieldName": "A String", # Optional. The name of the field. }, @@ -2994,7 +4092,7 @@

Method Details

"ragManagedDbConfig": { # Configuration message for RagManagedDb used by RagEngine. # The config of the RagManagedDb used by RagEngine. "basic": { # Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen. # Sets the RagManagedDb to the Basic tier. }, - "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. + "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen. }, "unprovisioned": { # Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API. # Sets the RagManagedDb to the Unprovisioned tier. }, @@ -3008,7 +4106,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. @@ -3137,7 +4235,7 @@

Method Details

"ragManagedDbConfig": { # Configuration message for RagManagedDb used by RagEngine. # The config of the RagManagedDb used by RagEngine. "basic": { # Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen. # Sets the RagManagedDb to the Basic tier. }, - "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. + "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen. }, "unprovisioned": { # Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API. # Sets the RagManagedDb to the Unprovisioned tier. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index a18b4bc01c..7e8e38e706 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -83,6 +83,9 @@

Instance Methods

countTokens(endpoint, body=None, x__xgafv=None)

Perform a token counting.

+

+ embedContent(model, body=None, x__xgafv=None)

+

Embed content with multimodal inputs.

fetchPredictOperation(endpoint, body=None, x__xgafv=None)

Fetch an asynchronous online prediction operation.

@@ -124,50 +127,64 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -210,71 +227,90 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -313,99 +349,119 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -612,9 +668,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -622,6 +678,132 @@

Method Details

} +
+ embedContent(model, body=None, x__xgafv=None) + 
Embed content with multimodal inputs.
+
+Args:
+  model: string, Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.EmbedContent.
+  "autoTruncate": True or False, # Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.
+  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Input content to be embedded. Required.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+          "outcome": "A String", # Required. Outcome of the code execution.
+          "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+        },
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+          "code": "A String", # Required. The code to be executed.
+          "language": "A String", # Required. Programming language of the `code`.
+        },
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+          "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+            "a_key": "", # Properties of the object.
+          },
+          "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
+        },
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
+          "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+        "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "endOffset": "A String", # Optional. The end offset of the video.
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+          "startOffset": "A String", # Optional. The start offset of the video.
+        },
+      },
+    ],
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+  },
+  "outputDimensionality": 42, # Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
+  "taskType": "A String", # Optional. The task type of the embedding.
+  "title": "A String", # Optional. An optional title for the text.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for PredictionService.EmbedContent.
+  "embedding": { # A list of floats representing an embedding. # The embedding generated from the input content.
+    "values": [ # Embedding vector values.
+      3.14,
+    ],
+  },
+  "truncated": True or False, # Whether the input content was truncated before generating the embedding.
+  "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Metadata about the response(s).
+    "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
+    "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
+    "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
+    "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
+    "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
+    "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
+    "trafficType": "A String", # Output only. The traffic type for this request.
+  },
+}
+
+
fetchPredictOperation(endpoint, body=None, x__xgafv=None) 
Fetch an asynchronous online prediction operation.
@@ -676,71 +858,90 @@ 
Method Details

 { # Request message for [PredictionService.GenerateContent].
   "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
   "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
-    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
             "outcome": "A String", # Required. Outcome of the code execution.
             "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
           },
-          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
             "code": "A String", # Required. The code to be executed.
             "language": "A String", # Required. Programming language of the `code`.
           },
-          "fileData": { # URI based data. # Optional. URI based data.
-            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-            "fileUri": "A String", # Required. URI.
+          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
             "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
               "a_key": "", # Properties of the object.
             },
             "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
           },
-          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
             "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                "fileData": { # URI based data for function response. # URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+              },
+            ],
             "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
               "a_key": "", # Properties of the object.
             },
           },
-          "inlineData": { # Content blob. # Optional. Inlined bytes data.
-            "data": "A String", # Required. Raw bytes.
-            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+            "data": "A String", # Required. The raw bytes of the data.
+            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "text": "A String", # Optional. Text part (can be code).
-          "thought": True or False, # Optional. Indicates if the part is thought from the model.
+          "text": "A String", # Optional. The text content of the part.
+          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
           "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
             "endOffset": "A String", # Optional. The end offset of the video.
-            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
             "startOffset": "A String", # Optional. The start offset of the video.
           },
         },
       ],
-      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
     },
   ],
-  "generationConfig": { # Generation config. # Optional. Generation config.
-    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-    "candidateCount": 42, # Optional. Number of candidates to generate.
-    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-    "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+  "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config.
+    "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+    "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+    "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+    "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
       "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+      "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+        "compressionQuality": 42, # Optional. The compression quality of the output image.
+        "mimeType": "A String", # Optional. The image format that the output should be saved as.
+      },
+      "personGeneration": "A String", # Optional. Controls whether the model can generate people.
     },
-    "logprobs": 42, # Optional. Logit probabilities.
-    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-    "presencePenalty": 3.14, # Optional. Positive penalties.
-    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-    "responseModalities": [ # Optional. The modalities of the response.
+    "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+    "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+    "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+    "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+    "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+    "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+    "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+    "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
       "A String",
     ],
-    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
       "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
       "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
         # Object with schema name: GoogleCloudAiplatformV1Schema
@@ -779,104 +980,118 @@ 
Method Details

       "title": "A String", # Optional. The title of the Schema.
       "type": "A String", # Optional. The type of the data.
     },
-    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+    "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+      "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
         "modelRoutingPreference": "A String", # The model routing preference.
       },
-      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+      "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+        "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
       },
     },
-    "seed": 42, # Optional. Seed.
-    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+    "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+    "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+      "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
         "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-          { # Configuration for a single speaker in a multi speaker setup.
+          { # Configuration for a single speaker in a multi-speaker setup.
             "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-            "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
         ],
       },
-      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-          "voiceName": "A String", # The name of the preset voice to use.
+      "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+          "voiceName": "A String", # The name of the prebuilt voice to use.
         },
       },
     },
-    "stopSequences": [ # Optional. Stop sequences.
+    "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
       "A String",
     ],
-    "temperature": 3.14, # Optional. Controls the randomness of predictions.
-    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+    "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+    "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+      "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+      "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
     },
-    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+    "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+    "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
   },
   "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
     "a_key": "A String",
   },
-  "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
-    "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
-    "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+  "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+    "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+    "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
   },
   "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
-    { # Safety settings.
-      "category": "A String", # Required. Harm category.
-      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
-      "threshold": "A String", # Required. The harm block threshold.
+    { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
+      "category": "A String", # Required. The harm category to be blocked.
+      "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.
+      "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.
     },
   ],
-  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
   "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
     "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
@@ -897,6 +1112,12 @@ 
Method Details

     { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
       "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
       },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
       "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
         "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
         "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
@@ -1104,179 +1325,193 @@ 
Method Details

     { # Response message for [PredictionService.GenerateContent].
   "candidates": [ # Output only. Generated candidates.
     { # A response candidate generated from the model.
-      "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
-      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
-        "citations": [ # Output only. List of citations.
-          { # Source attributions for content.
-            "endIndex": 42, # Output only. End index into the content.
-            "license": "A String", # Output only. License of the attribution.
-            "publicationDate": { # 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 # Output only. Publication date of the attribution.
+      "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.
+      "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content.
+        "citations": [ # Output only. A list of citations for the content.
+          { # A citation for a piece of generatedcontent.
+            "endIndex": 42, # Output only. The end index of the citation in the content.
+            "license": "A String", # Output only. The license of the source of the citation.
+            "publicationDate": { # 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 # Output only. The publication date of the source of the citation.
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
               "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
             },
-            "startIndex": 42, # Output only. Start index into the content.
-            "title": "A String", # Output only. Title of the attribution.
-            "uri": "A String", # Output only. Url reference of the attribution.
+            "startIndex": 42, # Output only. The start index of the citation in the content.
+            "title": "A String", # Output only. The title of the source of the citation.
+            "uri": "A String", # Output only. The URI of the source of the citation.
           },
         ],
       },
-      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
-        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
               "outcome": "A String", # Required. Outcome of the code execution.
               "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
             },
-            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
               "code": "A String", # Required. The code to be executed.
               "language": "A String", # Required. Programming language of the `code`.
             },
-            "fileData": { # URI based data. # Optional. URI based data.
-              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-              "fileUri": "A String", # Required. URI.
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
               "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                 "a_key": "", # Properties of the object.
               },
               "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
             },
-            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
               "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
               "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                 "a_key": "", # Properties of the object.
               },
             },
-            "inlineData": { # Content blob. # Optional. Inlined bytes data.
-              "data": "A String", # Required. Raw bytes.
-              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "text": "A String", # Optional. Text part (can be code).
-            "thought": True or False, # Optional. Indicates if the part is thought from the model.
+            "text": "A String", # Optional. The text content of the part.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
             "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
               "endOffset": "A String", # Optional. The end offset of the video.
-              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
               "startOffset": "A String", # Optional. The start offset of the video.
             },
           },
         ],
-        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-      },
-      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
-      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
-      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
-        "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-        "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-          { # Grounding chunk.
-            "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-              "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                  { # Encapsulates a review snippet.
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.
+      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.
+      "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.
+        "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+        "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+          { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+            "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+              "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                  { # A review snippet that is used to generate the answer.
                     "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                    "reviewId": "A String", # Id of the review referencing the place.
-                    "title": "A String", # Title of the review.
+                    "reviewId": "A String", # The ID of the review that is being referenced.
+                    "title": "A String", # The title of the review.
                   },
                 ],
               },
-              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-              "text": "A String", # Text of the place answer.
-              "title": "A String", # Title of the place.
-              "uri": "A String", # URI reference of the place.
-            },
-            "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-              "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+              "text": "A String", # The text of the place answer.
+              "title": "A String", # The title of the place.
+              "uri": "A String", # The URI of the place.
+            },
+            "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+              "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
                 "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                   "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                   "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                 },
                 "text": "A String", # The content of the chunk.
               },
-              "text": "A String", # Text of the attribution.
-              "title": "A String", # Title of the attribution.
-              "uri": "A String", # URI reference of the attribution.
+              "text": "A String", # The content of the retrieved data source.
+              "title": "A String", # The title of the retrieved data source.
+              "uri": "A String", # The URI of the retrieved data source.
             },
-            "web": { # Chunk from the web. # Grounding chunk from the web.
-              "domain": "A String", # Domain of the (original) URI.
-              "title": "A String", # Title of the chunk.
-              "uri": "A String", # URI reference of the chunk.
+            "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+              "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+              "title": "A String", # The title of the web page that contains the evidence.
+              "uri": "A String", # The URI of the web page that contains the evidence.
             },
           },
         ],
-        "groundingSupports": [ # Optional. List of grounding support.
-          { # Grounding support.
-            "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+        "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+          { # A collection of supporting references for a segment of the model's response.
+            "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
               3.14,
             ],
-            "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+            "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
               42,
             ],
-            "segment": { # Segment of the content. # Segment of the content this support belongs to.
-              "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-              "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-              "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-              "text": "A String", # Output only. The text corresponding to the segment from the response.
+            "segment": { # A segment of the content. # The content segment that this support message applies to.
+              "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+              "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+              "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+              "text": "A String", # Output only. The text of the segment.
             },
           },
         ],
-        "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-          "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+        "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+          "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
         },
-        "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-          "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-          "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+        "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+          "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+          "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
         },
-        "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-          { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-            "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-            "sourceId": "A String", # Id of the place or review.
+        "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+          { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+            "flagContentUri": "A String", # The URI that can be used to flag the content.
+            "sourceId": "A String", # The ID of the place or review.
           },
         ],
-        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+        "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
           "A String",
         ],
       },
-      "index": 42, # Output only. Index of the candidate.
-      "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
-        "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
-          { # Candidate for the logprobs token and score.
-            "logProbability": 3.14, # The candidate's log probability.
-            "token": "A String", # The candidate's token string value.
-            "tokenId": 42, # The candidate's token id value.
+      "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.
+      "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".
+        "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.
+          { # A single token and its associated log probability.
+            "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+            "token": "A String", # The token's string representation.
+            "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
           },
         ],
-        "topCandidates": [ # Length = total number of decoding steps.
-          { # Candidates with top log probabilities at each decoding step.
-            "candidates": [ # Sorted by log probability in descending order.
-              { # Candidate for the logprobs token and score.
-                "logProbability": 3.14, # The candidate's log probability.
-                "token": "A String", # The candidate's token string value.
-                "tokenId": 42, # The candidate's token id value.
+        "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.
+          { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.
+            "candidates": [ # The list of candidate tokens, sorted by log probability in descending order.
+              { # A single token and its associated log probability.
+                "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+                "token": "A String", # The token's string representation.
+                "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
               },
             ],
           },
         ],
       },
-      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
-        { # Safety rating corresponding to the generated content.
-          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-          "category": "A String", # Output only. Harm category.
+      "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
+        { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+          "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+          "category": "A String", # Output only. The harm category of this rating.
           "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-          "probability": "A String", # Output only. Harm probability levels in the content.
-          "probabilityScore": 3.14, # Output only. Harm probability score.
-          "severity": "A String", # Output only. Harm severity levels in the content.
-          "severityScore": 3.14, # Output only. Harm severity score.
+          "probability": "A String", # Output only. The probability of harm for this category.
+          "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+          "severity": "A String", # Output only. The severity of harm for this category.
+          "severityScore": 3.14, # Output only. The severity score of harm for this category.
         },
       ],
-      "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool.
-        "urlMetadata": [ # Output only. List of url context.
-          { # Context of the a single url retrieval.
-            "retrievedUrl": "A String", # Retrieved url by the tool.
-            "urlRetrievalStatus": "A String", # Status of the url retrieval.
+      "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
+        "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.
+          { # The metadata for a single URL retrieval.
+            "retrievedUrl": "A String", # The URL retrieved by the tool.
+            "urlRetrievalStatus": "A String", # The status of the URL retrieval.
           },
         ],
       },
@@ -1288,46 +1523,46 @@ 
Method Details

     "blockReason": "A String", # Output only. The reason why the prompt was blocked.
     "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked.
     "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category.
-      { # Safety rating corresponding to the generated content.
-        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-        "category": "A String", # Output only. Harm category.
+      { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+        "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+        "category": "A String", # Output only. The harm category of this rating.
         "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-        "probability": "A String", # Output only. Harm probability levels in the content.
-        "probabilityScore": 3.14, # Output only. Harm probability score.
-        "severity": "A String", # Output only. Harm severity levels in the content.
-        "severityScore": 3.14, # Output only. Harm severity score.
+        "probability": "A String", # Output only. The probability of harm for this category.
+        "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+        "severity": "A String", # Output only. The severity of harm for this category.
+        "severityScore": 3.14, # Output only. The severity score of harm for this category.
       },
     ],
   },
   "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id.
   "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s).
     "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
     "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
     "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
     "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
     "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
     "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
@@ -1349,6 +1584,9 @@ 
Method Details

   "instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
     "",
   ],
+  "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.
+    "a_key": "A String",
+  },
   "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.
 }
 
@@ -1657,71 +1895,90 @@ 
Method Details

 { # Request message for [PredictionService.GenerateContent].
   "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
   "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
-    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
             "outcome": "A String", # Required. Outcome of the code execution.
             "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
           },
-          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
             "code": "A String", # Required. The code to be executed.
             "language": "A String", # Required. Programming language of the `code`.
           },
-          "fileData": { # URI based data. # Optional. URI based data.
-            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-            "fileUri": "A String", # Required. URI.
+          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
             "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
               "a_key": "", # Properties of the object.
             },
             "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
           },
-          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
             "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                "fileData": { # URI based data for function response. # URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+              },
+            ],
             "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
               "a_key": "", # Properties of the object.
             },
           },
-          "inlineData": { # Content blob. # Optional. Inlined bytes data.
-            "data": "A String", # Required. Raw bytes.
-            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+            "data": "A String", # Required. The raw bytes of the data.
+            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "text": "A String", # Optional. Text part (can be code).
-          "thought": True or False, # Optional. Indicates if the part is thought from the model.
+          "text": "A String", # Optional. The text content of the part.
+          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
           "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
             "endOffset": "A String", # Optional. The end offset of the video.
-            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
             "startOffset": "A String", # Optional. The start offset of the video.
           },
         },
       ],
-      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
     },
   ],
-  "generationConfig": { # Generation config. # Optional. Generation config.
-    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-    "candidateCount": 42, # Optional. Number of candidates to generate.
-    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-    "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+  "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config.
+    "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+    "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+    "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+    "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
       "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+      "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+        "compressionQuality": 42, # Optional. The compression quality of the output image.
+        "mimeType": "A String", # Optional. The image format that the output should be saved as.
+      },
+      "personGeneration": "A String", # Optional. Controls whether the model can generate people.
     },
-    "logprobs": 42, # Optional. Logit probabilities.
-    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-    "presencePenalty": 3.14, # Optional. Positive penalties.
-    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-    "responseModalities": [ # Optional. The modalities of the response.
+    "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+    "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+    "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+    "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+    "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+    "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+    "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+    "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
       "A String",
     ],
-    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
       "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
       "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
         # Object with schema name: GoogleCloudAiplatformV1Schema
@@ -1760,104 +2017,118 @@ 
Method Details

       "title": "A String", # Optional. The title of the Schema.
       "type": "A String", # Optional. The type of the data.
     },
-    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+    "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+      "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
         "modelRoutingPreference": "A String", # The model routing preference.
       },
-      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+      "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+        "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
       },
     },
-    "seed": 42, # Optional. Seed.
-    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+    "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+    "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+      "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
         "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-          { # Configuration for a single speaker in a multi speaker setup.
+          { # Configuration for a single speaker in a multi-speaker setup.
             "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-            "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
         ],
       },
-      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-          "voiceName": "A String", # The name of the preset voice to use.
+      "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+          "voiceName": "A String", # The name of the prebuilt voice to use.
         },
       },
     },
-    "stopSequences": [ # Optional. Stop sequences.
+    "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
       "A String",
     ],
-    "temperature": 3.14, # Optional. Controls the randomness of predictions.
-    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+    "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+    "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+      "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+      "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
     },
-    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+    "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+    "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
   },
   "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
     "a_key": "A String",
   },
-  "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
-    "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
-    "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+  "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+    "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+    "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
   },
   "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
-    { # Safety settings.
-      "category": "A String", # Required. Harm category.
-      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
-      "threshold": "A String", # Required. The harm block threshold.
+    { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
+      "category": "A String", # Required. The harm category to be blocked.
+      "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.
+      "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.
     },
   ],
-  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
   "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
     "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
@@ -1878,6 +2149,12 @@ 
Method Details

     { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
       "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
       },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
       "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
         "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
         "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
@@ -2085,179 +2362,193 @@ 
Method Details

     { # Response message for [PredictionService.GenerateContent].
   "candidates": [ # Output only. Generated candidates.
     { # A response candidate generated from the model.
-      "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
-      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
-        "citations": [ # Output only. List of citations.
-          { # Source attributions for content.
-            "endIndex": 42, # Output only. End index into the content.
-            "license": "A String", # Output only. License of the attribution.
-            "publicationDate": { # 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 # Output only. Publication date of the attribution.
+      "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.
+      "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content.
+        "citations": [ # Output only. A list of citations for the content.
+          { # A citation for a piece of generatedcontent.
+            "endIndex": 42, # Output only. The end index of the citation in the content.
+            "license": "A String", # Output only. The license of the source of the citation.
+            "publicationDate": { # 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 # Output only. The publication date of the source of the citation.
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
               "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
             },
-            "startIndex": 42, # Output only. Start index into the content.
-            "title": "A String", # Output only. Title of the attribution.
-            "uri": "A String", # Output only. Url reference of the attribution.
+            "startIndex": 42, # Output only. The start index of the citation in the content.
+            "title": "A String", # Output only. The title of the source of the citation.
+            "uri": "A String", # Output only. The URI of the source of the citation.
           },
         ],
       },
-      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
-        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
               "outcome": "A String", # Required. Outcome of the code execution.
               "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
             },
-            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
               "code": "A String", # Required. The code to be executed.
               "language": "A String", # Required. Programming language of the `code`.
             },
-            "fileData": { # URI based data. # Optional. URI based data.
-              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-              "fileUri": "A String", # Required. URI.
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
               "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                 "a_key": "", # Properties of the object.
               },
               "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
             },
-            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
               "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
               "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                 "a_key": "", # Properties of the object.
               },
             },
-            "inlineData": { # Content blob. # Optional. Inlined bytes data.
-              "data": "A String", # Required. Raw bytes.
-              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "text": "A String", # Optional. Text part (can be code).
-            "thought": True or False, # Optional. Indicates if the part is thought from the model.
+            "text": "A String", # Optional. The text content of the part.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
             "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
               "endOffset": "A String", # Optional. The end offset of the video.
-              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
               "startOffset": "A String", # Optional. The start offset of the video.
             },
           },
         ],
-        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-      },
-      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
-      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
-      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
-        "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-        "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-          { # Grounding chunk.
-            "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-              "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                  { # Encapsulates a review snippet.
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.
+      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.
+      "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.
+        "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+        "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+          { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+            "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+              "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                  { # A review snippet that is used to generate the answer.
                     "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                    "reviewId": "A String", # Id of the review referencing the place.
-                    "title": "A String", # Title of the review.
+                    "reviewId": "A String", # The ID of the review that is being referenced.
+                    "title": "A String", # The title of the review.
                   },
                 ],
               },
-              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-              "text": "A String", # Text of the place answer.
-              "title": "A String", # Title of the place.
-              "uri": "A String", # URI reference of the place.
-            },
-            "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-              "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+              "text": "A String", # The text of the place answer.
+              "title": "A String", # The title of the place.
+              "uri": "A String", # The URI of the place.
+            },
+            "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+              "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
                 "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                   "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                   "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                 },
                 "text": "A String", # The content of the chunk.
               },
-              "text": "A String", # Text of the attribution.
-              "title": "A String", # Title of the attribution.
-              "uri": "A String", # URI reference of the attribution.
+              "text": "A String", # The content of the retrieved data source.
+              "title": "A String", # The title of the retrieved data source.
+              "uri": "A String", # The URI of the retrieved data source.
             },
-            "web": { # Chunk from the web. # Grounding chunk from the web.
-              "domain": "A String", # Domain of the (original) URI.
-              "title": "A String", # Title of the chunk.
-              "uri": "A String", # URI reference of the chunk.
+            "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+              "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+              "title": "A String", # The title of the web page that contains the evidence.
+              "uri": "A String", # The URI of the web page that contains the evidence.
             },
           },
         ],
-        "groundingSupports": [ # Optional. List of grounding support.
-          { # Grounding support.
-            "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+        "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+          { # A collection of supporting references for a segment of the model's response.
+            "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
               3.14,
             ],
-            "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+            "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
               42,
             ],
-            "segment": { # Segment of the content. # Segment of the content this support belongs to.
-              "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-              "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-              "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-              "text": "A String", # Output only. The text corresponding to the segment from the response.
+            "segment": { # A segment of the content. # The content segment that this support message applies to.
+              "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+              "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+              "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+              "text": "A String", # Output only. The text of the segment.
             },
           },
         ],
-        "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-          "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+        "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+          "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
         },
-        "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-          "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-          "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+        "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+          "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+          "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
         },
-        "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-          { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-            "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-            "sourceId": "A String", # Id of the place or review.
+        "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+          { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+            "flagContentUri": "A String", # The URI that can be used to flag the content.
+            "sourceId": "A String", # The ID of the place or review.
           },
         ],
-        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+        "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
           "A String",
         ],
       },
-      "index": 42, # Output only. Index of the candidate.
-      "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
-        "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
-          { # Candidate for the logprobs token and score.
-            "logProbability": 3.14, # The candidate's log probability.
-            "token": "A String", # The candidate's token string value.
-            "tokenId": 42, # The candidate's token id value.
+      "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.
+      "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".
+        "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.
+          { # A single token and its associated log probability.
+            "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+            "token": "A String", # The token's string representation.
+            "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
           },
         ],
-        "topCandidates": [ # Length = total number of decoding steps.
-          { # Candidates with top log probabilities at each decoding step.
-            "candidates": [ # Sorted by log probability in descending order.
-              { # Candidate for the logprobs token and score.
-                "logProbability": 3.14, # The candidate's log probability.
-                "token": "A String", # The candidate's token string value.
-                "tokenId": 42, # The candidate's token id value.
+        "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.
+          { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.
+            "candidates": [ # The list of candidate tokens, sorted by log probability in descending order.
+              { # A single token and its associated log probability.
+                "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+                "token": "A String", # The token's string representation.
+                "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
               },
             ],
           },
         ],
       },
-      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
-        { # Safety rating corresponding to the generated content.
-          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-          "category": "A String", # Output only. Harm category.
+      "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
+        { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+          "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+          "category": "A String", # Output only. The harm category of this rating.
           "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-          "probability": "A String", # Output only. Harm probability levels in the content.
-          "probabilityScore": 3.14, # Output only. Harm probability score.
-          "severity": "A String", # Output only. Harm severity levels in the content.
-          "severityScore": 3.14, # Output only. Harm severity score.
+          "probability": "A String", # Output only. The probability of harm for this category.
+          "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+          "severity": "A String", # Output only. The severity of harm for this category.
+          "severityScore": 3.14, # Output only. The severity score of harm for this category.
         },
       ],
-      "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool.
-        "urlMetadata": [ # Output only. List of url context.
-          { # Context of the a single url retrieval.
-            "retrievedUrl": "A String", # Retrieved url by the tool.
-            "urlRetrievalStatus": "A String", # Status of the url retrieval.
+      "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
+        "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.
+          { # The metadata for a single URL retrieval.
+            "retrievedUrl": "A String", # The URL retrieved by the tool.
+            "urlRetrievalStatus": "A String", # The status of the URL retrieval.
           },
         ],
       },
@@ -2269,46 +2560,46 @@ 
Method Details

     "blockReason": "A String", # Output only. The reason why the prompt was blocked.
     "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked.
     "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category.
-      { # Safety rating corresponding to the generated content.
-        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-        "category": "A String", # Output only. Harm category.
+      { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+        "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+        "category": "A String", # Output only. The harm category of this rating.
         "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-        "probability": "A String", # Output only. Harm probability levels in the content.
-        "probabilityScore": 3.14, # Output only. Harm probability score.
-        "severity": "A String", # Output only. Harm severity levels in the content.
-        "severityScore": 3.14, # Output only. Harm severity score.
+        "probability": "A String", # Output only. The probability of harm for this category.
+        "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+        "severity": "A String", # Output only. The severity of harm for this category.
+        "severityScore": 3.14, # Output only. The severity score of harm for this category.
       },
     ],
   },
   "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id.
   "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s).
     "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
     "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
     "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
     "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
     "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
     "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
index 63e715f8f3..94033068fd 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.ragCorpora.html
@@ -132,6 +132,8 @@ 
Method Details

     "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
   },
   "name": "A String", # Output only. The resource name of the RagCorpus.
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
   "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
   "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
     "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
@@ -259,6 +261,8 @@ 
Method Details

     "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
   },
   "name": "A String", # Output only. The resource name of the RagCorpus.
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
   "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
   "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
     "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
@@ -327,6 +331,8 @@ 
Method Details

         "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
       },
       "name": "A String", # Output only. The resource name of the RagCorpus.
+      "satisfiesPzi": True or False, # Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Output only. Reserved for future use.
       "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
       "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
         "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
@@ -401,6 +407,8 @@ 
Method Details

     "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created.
   },
   "name": "A String", # Output only. The resource name of the RagCorpus.
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
   "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
   "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
     "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
index ead6d15837..9c6268ab92 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html
@@ -176,10 +176,21 @@ 
Method Details

     "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.
       "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
       "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
-      "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
+      "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.
       "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
     },
     "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
+    "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint.
+      "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request.
+        "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.
+      },
+      "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application.
+        "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.
+        "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent".
+        "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt".
+        "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.
+      },
+    },
   },
   "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
 }
@@ -318,10 +329,21 @@ 
Method Details

     "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.
       "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
       "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
-      "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
+      "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.
       "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
     },
     "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
+    "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint.
+      "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request.
+        "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.
+      },
+      "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application.
+        "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.
+        "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent".
+        "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt".
+        "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.
+      },
+    },
   },
   "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
 }
@@ -402,10 +424,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. }, @@ -491,10 +524,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 6de0884a27..87157e5610 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -166,6 +166,17 @@

Method Details

"checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. + "adapterSize": "A String", # Optional. Adapter size for preference optimization. + "beta": 3.14, # Optional. Weight for KL Divergence regularization. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -193,6 +204,210 @@

Method Details

}, "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. + "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. + "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. + "A String", + ], + "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + "A String", + ], + "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset. + "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. + "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. + "userDatasetExamples": [ # Output only. Sample user examples in the training dataset. + { # Input example for preference optimization. + "completions": [ # List of completions for a given prompt. + { # Completion and its preference score. + "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "score": 3.14, # The score for the given completion. + }, + ], + "contents": [ # Multi-turn contents that represents the Prompt. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + ], + "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "userOutputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user output tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + }, "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. "A String", @@ -207,50 +422,64 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens. @@ -344,6 +573,17 @@

Method Details

"checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. + "adapterSize": "A String", # Optional. Adapter size for preference optimization. + "beta": 3.14, # Optional. Weight for KL Divergence regularization. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -371,6 +611,210 @@

Method Details

}, "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. + "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. + "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. + "A String", + ], + "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + "A String", + ], + "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset. + "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. + "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. + "userDatasetExamples": [ # Output only. Sample user examples in the training dataset. + { # Input example for preference optimization. + "completions": [ # List of completions for a given prompt. + { # Completion and its preference score. + "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "score": 3.14, # The score for the given completion. + }, + ], + "contents": [ # Multi-turn contents that represents the Prompt. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + ], + "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "userOutputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user output tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + }, "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. "A String", @@ -385,50 +829,64 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens. @@ -529,6 +987,17 @@

Method Details

"checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. + "adapterSize": "A String", # Optional. Adapter size for preference optimization. + "beta": 3.14, # Optional. Weight for KL Divergence regularization. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -556,6 +1025,210 @@

Method Details

}, "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. + "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. + "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. + "A String", + ], + "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + "A String", + ], + "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset. + "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. + "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. + "userDatasetExamples": [ # Output only. Sample user examples in the training dataset. + { # Input example for preference optimization. + "completions": [ # List of completions for a given prompt. + { # Completion and its preference score. + "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "score": 3.14, # The score for the given completion. + }, + ], + "contents": [ # Multi-turn contents that represents the Prompt. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + ], + "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "userOutputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user output tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + }, "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. "A String", @@ -570,50 +1243,64 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens. @@ -720,6 +1407,17 @@

Method Details

"checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. + "adapterSize": "A String", # Optional. Adapter size for preference optimization. + "beta": 3.14, # Optional. Weight for KL Divergence regularization. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -747,6 +1445,210 @@

Method Details

}, "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. + "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. + "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. + "A String", + ], + "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + "A String", + ], + "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset. + "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. + "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. + "userDatasetExamples": [ # Output only. Sample user examples in the training dataset. + { # Input example for preference optimization. + "completions": [ # List of completions for a given prompt. + { # Completion and its preference score. + "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "score": 3.14, # The score for the given completion. + }, + ], + "contents": [ # Multi-turn contents that represents the Prompt. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + ], + "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "userOutputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user output tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + }, "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. "A String", @@ -761,50 +1663,64 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens. @@ -926,6 +1842,17 @@

Method Details

"checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. + "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. + "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. + "adapterSize": "A String", # Optional. Adapter size for preference optimization. + "beta": 3.14, # Optional. Weight for KL Divergence regularization. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file. + }, "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. "state": "A String", # Output only. The detailed state of the job. @@ -953,6 +1880,210 @@

Method Details

}, "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version. "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob. + "preferenceOptimizationDataStats": { # Statistics computed for datasets used for preference optimization. # Output only. Statistics for preference optimization. + "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples. + "A String", + ], + "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped. + "A String", + ], + "scoreVariancePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores variance per example. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "scoresDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for scores. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "totalBillableTokenCount": "A String", # Output only. Number of billable tokens in the tuning dataset. + "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. + "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. + "userDatasetExamples": [ # Output only. Sample user examples in the training dataset. + { # Input example for preference optimization. + "completions": [ # List of completions for a given prompt. + { # Completion and its preference score. + "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "score": 3.14, # The score for the given completion. + }, + ], + "contents": [ # Multi-turn contents that represents the Prompt. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + ], + "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + "userOutputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user output tokens. + "buckets": [ # Output only. Defines the histogram bucket. + { # Dataset bucket used to create a histogram for the distribution given a population of values. + "count": "A String", # Output only. Number of values in the bucket. + "left": 3.14, # Output only. Left bound of the bucket. + "right": 3.14, # Output only. Right bound of the bucket. + }, + ], + "max": 3.14, # Output only. The maximum of the population values. + "mean": 3.14, # Output only. The arithmetic mean of the values in the population. + "median": 3.14, # Output only. The median of the values in the population. + "min": 3.14, # Output only. The minimum of the population values. + "p5": 3.14, # Output only. The 5th percentile of the values in the population. + "p95": 3.14, # Output only. The 95th percentile of the values in the population. + "sum": 3.14, # Output only. Sum of a given population of values. + }, + }, "supervisedTuningDataStats": { # Tuning data statistics for Supervised Tuning. # The SFT Tuning data stats. "droppedExampleReasons": [ # Output only. For each index in `truncated_example_indices`, the user-facing reason why the example was dropped. "A String", @@ -967,50 +2098,64 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index db0830266e..d63164ddee 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -118,50 +118,64 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -204,71 +218,90 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -307,99 +340,119 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -606,9 +659,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -670,71 +723,90 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -773,104 +845,118 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -891,6 +977,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1098,179 +1190,193 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -1282,46 +1388,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -1916,6 +2022,9 @@

Method Details

"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. "", ], + "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + "a_key": "A String", + }, "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. } @@ -1996,71 +2105,90 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1Schema @@ -2099,104 +2227,118 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -2217,6 +2359,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -2424,179 +2572,193 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -2608,46 +2770,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. diff --git a/docs/dyn/aiplatform_v1.ragCorpora.html b/docs/dyn/aiplatform_v1.ragCorpora.html new file mode 100644 index 0000000000..3b0f785823 --- /dev/null +++ b/docs/dyn/aiplatform_v1.ragCorpora.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . ragCorpora

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ ragFiles() +

+

Returns the ragFiles Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.ragCorpora.operations.html b/docs/dyn/aiplatform_v1.ragCorpora.operations.html new file mode 100644 index 0000000000..6504f1393e --- /dev/null +++ b/docs/dyn/aiplatform_v1.ragCorpora.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . ragCorpora . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1.ragCorpora.ragFiles.html new file mode 100644 index 0000000000..84e6153ba7 --- /dev/null +++ b/docs/dyn/aiplatform_v1.ragCorpora.ragFiles.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . ragCorpora . ragFiles

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.ragCorpora.ragFiles.operations.html b/docs/dyn/aiplatform_v1.ragCorpora.ragFiles.operations.html new file mode 100644 index 0000000000..b454c33309 --- /dev/null +++ b/docs/dyn/aiplatform_v1.ragCorpora.ragFiles.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . ragCorpora . ragFiles . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.ragEngineConfig.html b/docs/dyn/aiplatform_v1.ragEngineConfig.html new file mode 100644 index 0000000000..786ae668b4 --- /dev/null +++ b/docs/dyn/aiplatform_v1.ragEngineConfig.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . ragEngineConfig

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.ragEngineConfig.operations.html b/docs/dyn/aiplatform_v1.ragEngineConfig.operations.html new file mode 100644 index 0000000000..b06494079a --- /dev/null +++ b/docs/dyn/aiplatform_v1.ragEngineConfig.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . ragEngineConfig . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index cd353c5349..8faeecc0d4 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -74,6 +74,11 @@

Vertex AI API . reasoningEngines

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+

close()

Close httplib2 connections.

@@ -170,10 +175,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -313,10 +329,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -397,10 +424,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. }, @@ -486,10 +524,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.operations.html b/docs/dyn/aiplatform_v1.reasoningEngines.operations.html new file mode 100644 index 0000000000..9f1c9d651f --- /dev/null +++ b/docs/dyn/aiplatform_v1.reasoningEngines.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.schedules.html b/docs/dyn/aiplatform_v1.schedules.html new file mode 100644 index 0000000000..ef3a48f56d --- /dev/null +++ b/docs/dyn/aiplatform_v1.schedules.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . schedules

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.schedules.operations.html b/docs/dyn/aiplatform_v1.schedules.operations.html new file mode 100644 index 0000000000..a8a8e97d98 --- /dev/null +++ b/docs/dyn/aiplatform_v1.schedules.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . schedules . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.specialistPools.html b/docs/dyn/aiplatform_v1.specialistPools.html new file mode 100644 index 0000000000..ca72ebe760 --- /dev/null +++ b/docs/dyn/aiplatform_v1.specialistPools.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . specialistPools

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.specialistPools.operations.html b/docs/dyn/aiplatform_v1.specialistPools.operations.html new file mode 100644 index 0000000000..d9c5327695 --- /dev/null +++ b/docs/dyn/aiplatform_v1.specialistPools.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . specialistPools . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.studies.html b/docs/dyn/aiplatform_v1.studies.html new file mode 100644 index 0000000000..787a480e47 --- /dev/null +++ b/docs/dyn/aiplatform_v1.studies.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . studies

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ trials() +

+

Returns the trials Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.studies.operations.html b/docs/dyn/aiplatform_v1.studies.operations.html new file mode 100644 index 0000000000..e72ce3a725 --- /dev/null +++ b/docs/dyn/aiplatform_v1.studies.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . studies . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.studies.trials.html b/docs/dyn/aiplatform_v1.studies.trials.html new file mode 100644 index 0000000000..58965d4dc1 --- /dev/null +++ b/docs/dyn/aiplatform_v1.studies.trials.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . studies . trials

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.studies.trials.operations.html b/docs/dyn/aiplatform_v1.studies.trials.operations.html new file mode 100644 index 0000000000..5fcf5f3651 --- /dev/null +++ b/docs/dyn/aiplatform_v1.studies.trials.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . studies . trials . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.experiments.html b/docs/dyn/aiplatform_v1.tensorboards.experiments.html new file mode 100644 index 0000000000..d040f42df7 --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.experiments.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . tensorboards . experiments

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ runs() +

+

Returns the runs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.experiments.operations.html b/docs/dyn/aiplatform_v1.tensorboards.experiments.operations.html new file mode 100644 index 0000000000..2eb24340d7 --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.experiments.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . tensorboards . experiments . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.html b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.html new file mode 100644 index 0000000000..04fc89ad2a --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . tensorboards . experiments . runs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ timeSeries() +

+

Returns the timeSeries Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.operations.html b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.operations.html new file mode 100644 index 0000000000..ca475b270b --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . tensorboards . experiments . runs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.html b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.html new file mode 100644 index 0000000000..cd89b930e8 --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . tensorboards . experiments . runs . timeSeries

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.operations.html b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.operations.html new file mode 100644 index 0000000000..e3b25489d8 --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.experiments.runs.timeSeries.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . tensorboards . experiments . runs . timeSeries . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.html b/docs/dyn/aiplatform_v1.tensorboards.html new file mode 100644 index 0000000000..214c307794 --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . tensorboards

+

Instance Methods

+

+ experiments() +

+

Returns the experiments Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tensorboards.operations.html b/docs/dyn/aiplatform_v1.tensorboards.operations.html new file mode 100644 index 0000000000..6eb7e8bd8d --- /dev/null +++ b/docs/dyn/aiplatform_v1.tensorboards.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . tensorboards . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.trainingPipelines.html b/docs/dyn/aiplatform_v1.trainingPipelines.html new file mode 100644 index 0000000000..ae338414b6 --- /dev/null +++ b/docs/dyn/aiplatform_v1.trainingPipelines.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . trainingPipelines

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.trainingPipelines.operations.html b/docs/dyn/aiplatform_v1.trainingPipelines.operations.html new file mode 100644 index 0000000000..520f9f537b --- /dev/null +++ b/docs/dyn/aiplatform_v1.trainingPipelines.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . trainingPipelines . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tuningJobs.html b/docs/dyn/aiplatform_v1.tuningJobs.html new file mode 100644 index 0000000000..5207ed1258 --- /dev/null +++ b/docs/dyn/aiplatform_v1.tuningJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . tuningJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.tuningJobs.operations.html b/docs/dyn/aiplatform_v1.tuningJobs.operations.html new file mode 100644 index 0000000000..a80259142a --- /dev/null +++ b/docs/dyn/aiplatform_v1.tuningJobs.operations.html @@ -0,0 +1,233 @@ + + + +

Vertex AI API . tuningJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.agents.html b/docs/dyn/aiplatform_v1beta1.agents.html new file mode 100644 index 0000000000..a80472143d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.agents.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . agents

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.agents.operations.html b/docs/dyn/aiplatform_v1beta1.agents.operations.html new file mode 100644 index 0000000000..b29f17524b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.agents.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . agents . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.apps.html b/docs/dyn/aiplatform_v1beta1.apps.html new file mode 100644 index 0000000000..a1a6d5c564 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.apps.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . apps

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.apps.operations.html b/docs/dyn/aiplatform_v1beta1.apps.operations.html new file mode 100644 index 0000000000..b4db0707fe --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.apps.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . apps . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.customJobs.html b/docs/dyn/aiplatform_v1beta1.customJobs.html new file mode 100644 index 0000000000..5234f414b8 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.customJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . customJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.customJobs.operations.html b/docs/dyn/aiplatform_v1beta1.customJobs.operations.html new file mode 100644 index 0000000000..fe4eb065d5 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.customJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . customJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.dataLabelingJobs.html b/docs/dyn/aiplatform_v1beta1.dataLabelingJobs.html new file mode 100644 index 0000000000..afd11f14b4 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.dataLabelingJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . dataLabelingJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.dataLabelingJobs.operations.html b/docs/dyn/aiplatform_v1beta1.dataLabelingJobs.operations.html new file mode 100644 index 0000000000..d3e8a42c31 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.dataLabelingJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . dataLabelingJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.html b/docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.html new file mode 100644 index 0000000000..296b219e06 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . datasets . annotationSpecs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.operations.html b/docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.operations.html new file mode 100644 index 0000000000..7c53a36cd0 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.annotationSpecs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . annotationSpecs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.html b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.html new file mode 100644 index 0000000000..d0391b0eaf --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . datasets . dataItems . annotations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.operations.html b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.operations.html new file mode 100644 index 0000000000..11915b6429 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.annotations.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . dataItems . annotations . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.dataItems.html b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.html new file mode 100644 index 0000000000..b0f8b0daac --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . datasets . dataItems

+

Instance Methods

+

+ annotations() +

+

Returns the annotations Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.dataItems.operations.html b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.operations.html new file mode 100644 index 0000000000..09b1a4464c --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.dataItems.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . dataItems . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.html b/docs/dyn/aiplatform_v1beta1.datasets.html index 4810196b24..6622a85fb1 100644 --- a/docs/dyn/aiplatform_v1beta1.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.datasets.html @@ -74,11 +74,31 @@

Vertex AI API . datasets

Instance Methods

+

+ annotationSpecs() +

+

Returns the annotationSpecs Resource.

+ +

+ dataItems() +

+

Returns the dataItems Resource.

+

datasetVersions()

Returns the datasetVersions Resource.

+

+ operations() +

+

Returns the operations Resource.

+ +

+ savedQueries() +

+

Returns the savedQueries Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1beta1.datasets.operations.html b/docs/dyn/aiplatform_v1beta1.datasets.operations.html new file mode 100644 index 0000000000..277fe69759 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.savedQueries.html b/docs/dyn/aiplatform_v1beta1.datasets.savedQueries.html new file mode 100644 index 0000000000..b1d53413f3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.savedQueries.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . datasets . savedQueries

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.datasets.savedQueries.operations.html b/docs/dyn/aiplatform_v1beta1.datasets.savedQueries.operations.html new file mode 100644 index 0000000000..9ee2795171 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.datasets.savedQueries.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . datasets . savedQueries . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.deploymentResourcePools.html new file mode 100644 index 0000000000..7cfec455a2 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.deploymentResourcePools.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . deploymentResourcePools

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.deploymentResourcePools.operations.html b/docs/dyn/aiplatform_v1beta1.deploymentResourcePools.operations.html new file mode 100644 index 0000000000..882fd09fcb --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.deploymentResourcePools.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . deploymentResourcePools . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.edgeDevices.html b/docs/dyn/aiplatform_v1beta1.edgeDevices.html new file mode 100644 index 0000000000..6cd998fa37 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.edgeDevices.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . edgeDevices

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.edgeDevices.operations.html b/docs/dyn/aiplatform_v1beta1.edgeDevices.operations.html new file mode 100644 index 0000000000..fa21c73833 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.edgeDevices.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . edgeDevices . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 7bbf4858e7..02c4131655 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -79,6 +79,11 @@

Instance Methods

Returns the chat Resource.

+

+ operations() +

+

Returns the operations Resource.

+

close()

Close httplib2 connections.

@@ -120,52 +125,66 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -208,76 +227,95 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -316,101 +354,121 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -624,9 +682,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -688,76 +746,95 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -796,106 +873,120 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -916,6 +1007,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1130,184 +1227,198 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -1319,46 +1430,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -1380,6 +1491,9 @@

Method Details

"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. "", ], + "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + "a_key": "A String", + }, "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. } @@ -1460,76 +1574,95 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1568,106 +1701,120 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1688,6 +1835,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1902,184 +2055,198 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -2091,46 +2258,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.operations.html b/docs/dyn/aiplatform_v1beta1.endpoints.operations.html new file mode 100644 index 0000000000..e188fd5818 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.endpoints.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . endpoints . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.evaluationItems.html new file mode 100644 index 0000000000..3f59494f6e --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationItems.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . evaluationItems

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationItems.operations.html b/docs/dyn/aiplatform_v1beta1.evaluationItems.operations.html new file mode 100644 index 0000000000..61389166df --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationItems.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . evaluationItems . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.evaluationRuns.html new file mode 100644 index 0000000000..6768245d16 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationRuns.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . evaluationRuns

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationRuns.operations.html b/docs/dyn/aiplatform_v1beta1.evaluationRuns.operations.html new file mode 100644 index 0000000000..d4ace2f983 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationRuns.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . evaluationRuns . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.evaluationSets.html new file mode 100644 index 0000000000..9740578571 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationSets.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . evaluationSets

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationSets.operations.html b/docs/dyn/aiplatform_v1beta1.evaluationSets.operations.html new file mode 100644 index 0000000000..8c3e2e524d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationSets.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . evaluationSets . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationTasks.html b/docs/dyn/aiplatform_v1beta1.evaluationTasks.html new file mode 100644 index 0000000000..f07cb66253 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationTasks.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . evaluationTasks

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.evaluationTasks.operations.html b/docs/dyn/aiplatform_v1beta1.evaluationTasks.operations.html new file mode 100644 index 0000000000..6306144812 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.evaluationTasks.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . evaluationTasks . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.exampleStores.html b/docs/dyn/aiplatform_v1beta1.exampleStores.html new file mode 100644 index 0000000000..48ecb041a4 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.exampleStores.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . exampleStores

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.exampleStores.operations.html b/docs/dyn/aiplatform_v1beta1.exampleStores.operations.html new file mode 100644 index 0000000000..ac0483fc67 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.exampleStores.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . exampleStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.extensionControllers.html b/docs/dyn/aiplatform_v1beta1.extensionControllers.html new file mode 100644 index 0000000000..0746f9f521 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.extensionControllers.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . extensionControllers

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.extensionControllers.operations.html b/docs/dyn/aiplatform_v1beta1.extensionControllers.operations.html new file mode 100644 index 0000000000..c431c6fdb4 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.extensionControllers.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . extensionControllers . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.extensions.html b/docs/dyn/aiplatform_v1beta1.extensions.html new file mode 100644 index 0000000000..41f7de982c --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.extensions.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . extensions

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.extensions.operations.html b/docs/dyn/aiplatform_v1beta1.extensions.operations.html new file mode 100644 index 0000000000..3371733556 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.extensions.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . extensions . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.html b/docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.html new file mode 100644 index 0000000000..3c54bc292a --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featureGroups . featureMonitors

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.operations.html b/docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.operations.html new file mode 100644 index 0000000000..bcad9d7576 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureGroups.featureMonitors.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureGroups . featureMonitors . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureGroups.features.html b/docs/dyn/aiplatform_v1beta1.featureGroups.features.html new file mode 100644 index 0000000000..42acad9fc5 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureGroups.features.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featureGroups . features

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureGroups.features.operations.html b/docs/dyn/aiplatform_v1beta1.featureGroups.features.operations.html new file mode 100644 index 0000000000..627cc88611 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureGroups.features.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureGroups . features . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureGroups.html b/docs/dyn/aiplatform_v1beta1.featureGroups.html new file mode 100644 index 0000000000..ca94383ede --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureGroups.html @@ -0,0 +1,101 @@ + + + +

Vertex AI API . featureGroups

+

Instance Methods

+

+ featureMonitors() +

+

Returns the featureMonitors Resource.

+ +

+ features() +

+

Returns the features Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureGroups.operations.html b/docs/dyn/aiplatform_v1beta1.featureGroups.operations.html new file mode 100644 index 0000000000..ac5494eff8 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureGroups.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureGroups . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.html new file mode 100644 index 0000000000..4a4161b84f --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featureOnlineStores . featureViews

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.operations.html b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.operations.html new file mode 100644 index 0000000000..1236880677 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.featureViews.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureOnlineStores . featureViews . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureOnlineStores.html b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.html new file mode 100644 index 0000000000..8b20840513 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featureOnlineStores

+

Instance Methods

+

+ featureViews() +

+

Returns the featureViews Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featureOnlineStores.operations.html b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.operations.html new file mode 100644 index 0000000000..13cc1f83f3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featureOnlineStores.operations.html @@ -0,0 +1,251 @@ + + + +

Vertex AI API . featureOnlineStores . operations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.html b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.html new file mode 100644 index 0000000000..5cd2e7ae20 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . featurestores . entityTypes . features

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.operations.html b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.operations.html new file mode 100644 index 0000000000..345e63f136 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.features.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . featurestores . entityTypes . features . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.html b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.html new file mode 100644 index 0000000000..fe5649aeed --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featurestores . entityTypes

+

Instance Methods

+

+ features() +

+

Returns the features Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.operations.html b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.operations.html new file mode 100644 index 0000000000..163c42fd5e --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featurestores.entityTypes.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . featurestores . entityTypes . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featurestores.html b/docs/dyn/aiplatform_v1beta1.featurestores.html new file mode 100644 index 0000000000..1c8d5dd488 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featurestores.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . featurestores

+

Instance Methods

+

+ entityTypes() +

+

Returns the entityTypes Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.featurestores.operations.html b/docs/dyn/aiplatform_v1beta1.featurestores.operations.html new file mode 100644 index 0000000000..e149037c84 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.featurestores.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . featurestores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index 043d00a90b..6d783048cb 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -74,26 +74,176 @@

Vertex AI API

Instance Methods

+

+ agents() +

+

Returns the agents Resource.

+ +

+ apps() +

+

Returns the apps Resource.

+

batchPredictionJobs()

Returns the batchPredictionJobs Resource.

+

+ customJobs() +

+

Returns the customJobs Resource.

+ +

+ dataLabelingJobs() +

+

Returns the dataLabelingJobs Resource.

+

datasets()

Returns the datasets Resource.

+

+ deploymentResourcePools() +

+

Returns the deploymentResourcePools Resource.

+ +

+ edgeDevices() +

+

Returns the edgeDevices Resource.

+

endpoints()

Returns the endpoints Resource.

+

+ evaluationItems() +

+

Returns the evaluationItems Resource.

+ +

+ evaluationRuns() +

+

Returns the evaluationRuns Resource.

+ +

+ evaluationSets() +

+

Returns the evaluationSets Resource.

+ +

+ evaluationTasks() +

+

Returns the evaluationTasks Resource.

+ +

+ exampleStores() +

+

Returns the exampleStores Resource.

+ +

+ extensionControllers() +

+

Returns the extensionControllers Resource.

+ +

+ extensions() +

+

Returns the extensions Resource.

+ +

+ featureGroups() +

+

Returns the featureGroups Resource.

+ +

+ featureOnlineStores() +

+

Returns the featureOnlineStores Resource.

+ +

+ featurestores() +

+

Returns the featurestores Resource.

+ +

+ hyperparameterTuningJobs() +

+

Returns the hyperparameterTuningJobs Resource.

+ +

+ indexEndpoints() +

+

Returns the indexEndpoints Resource.

+ +

+ indexes() +

+

Returns the indexes Resource.

+

media()

Returns the media Resource.

+

+ metadataStores() +

+

Returns the metadataStores Resource.

+ +

+ migratableResources() +

+

Returns the migratableResources Resource.

+ +

+ modelDeploymentMonitoringJobs() +

+

Returns the modelDeploymentMonitoringJobs Resource.

+ +

+ modelMonitors() +

+

Returns the modelMonitors Resource.

+ +

+ models() +

+

Returns the models Resource.

+ +

+ notebookExecutionJobs() +

+

Returns the notebookExecutionJobs Resource.

+ +

+ notebookRuntimeTemplates() +

+

Returns the notebookRuntimeTemplates Resource.

+ +

+ notebookRuntimes() +

+

Returns the notebookRuntimes Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ persistentResources() +

+

Returns the persistentResources Resource.

+ +

+ pipelineJobs() +

+

Returns the pipelineJobs Resource.

+

projects()

@@ -104,11 +254,56 @@

Instance Methods

Returns the publishers Resource.

+

+ ragCorpora() +

+

Returns the ragCorpora Resource.

+ +

+ ragEngineConfig() +

+

Returns the ragEngineConfig Resource.

+

reasoningEngines()

Returns the reasoningEngines Resource.

+

+ schedules() +

+

Returns the schedules Resource.

+ +

+ solvers() +

+

Returns the solvers Resource.

+ +

+ specialistPools() +

+

Returns the specialistPools Resource.

+ +

+ studies() +

+

Returns the studies Resource.

+ +

+ tensorboards() +

+

Returns the tensorboards Resource.

+ +

+ trainingPipelines() +

+

Returns the trainingPipelines Resource.

+ +

+ tuningJobs() +

+

Returns the tuningJobs Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.html new file mode 100644 index 0000000000..7a9ba91f63 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . hyperparameterTuningJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.operations.html b/docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.operations.html new file mode 100644 index 0000000000..8fd89a5443 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.hyperparameterTuningJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . hyperparameterTuningJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.indexEndpoints.html new file mode 100644 index 0000000000..393283d68d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.indexEndpoints.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . indexEndpoints

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.indexEndpoints.operations.html b/docs/dyn/aiplatform_v1beta1.indexEndpoints.operations.html new file mode 100644 index 0000000000..a8a5682997 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.indexEndpoints.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . indexEndpoints . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.indexes.html b/docs/dyn/aiplatform_v1beta1.indexes.html new file mode 100644 index 0000000000..b342a6e3e0 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.indexes.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . indexes

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.indexes.operations.html b/docs/dyn/aiplatform_v1beta1.indexes.operations.html new file mode 100644 index 0000000000..53f3f58499 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.indexes.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . indexes . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.html b/docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.html new file mode 100644 index 0000000000..508f8aa67f --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . metadataStores . artifacts

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.operations.html b/docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.operations.html new file mode 100644 index 0000000000..637d1ac050 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.artifacts.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . artifacts . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.contexts.html b/docs/dyn/aiplatform_v1beta1.metadataStores.contexts.html new file mode 100644 index 0000000000..36f05fdcc3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.contexts.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . metadataStores . contexts

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.contexts.operations.html b/docs/dyn/aiplatform_v1beta1.metadataStores.contexts.operations.html new file mode 100644 index 0000000000..dd58472e24 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.contexts.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . contexts . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.executions.html b/docs/dyn/aiplatform_v1beta1.metadataStores.executions.html new file mode 100644 index 0000000000..5379cf4023 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.executions.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . metadataStores . executions

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.executions.operations.html b/docs/dyn/aiplatform_v1beta1.metadataStores.executions.operations.html new file mode 100644 index 0000000000..070220884b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.executions.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . executions . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.html b/docs/dyn/aiplatform_v1beta1.metadataStores.html new file mode 100644 index 0000000000..2f7d6c956d --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.html @@ -0,0 +1,106 @@ + + + +

Vertex AI API . metadataStores

+

Instance Methods

+

+ artifacts() +

+

Returns the artifacts Resource.

+ +

+ contexts() +

+

Returns the contexts Resource.

+ +

+ executions() +

+

Returns the executions Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.metadataStores.operations.html b/docs/dyn/aiplatform_v1beta1.metadataStores.operations.html new file mode 100644 index 0000000000..fea7663269 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.metadataStores.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . metadataStores . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.migratableResources.html b/docs/dyn/aiplatform_v1beta1.migratableResources.html new file mode 100644 index 0000000000..d70219d48b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.migratableResources.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . migratableResources

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.migratableResources.operations.html b/docs/dyn/aiplatform_v1beta1.migratableResources.operations.html new file mode 100644 index 0000000000..e3f54df2c4 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.migratableResources.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . migratableResources . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.html b/docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.html new file mode 100644 index 0000000000..641dd292c9 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . modelDeploymentMonitoringJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.operations.html b/docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.operations.html new file mode 100644 index 0000000000..7075056753 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.modelDeploymentMonitoringJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . modelDeploymentMonitoringJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.modelMonitors.html b/docs/dyn/aiplatform_v1beta1.modelMonitors.html new file mode 100644 index 0000000000..74932ff620 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.modelMonitors.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . modelMonitors

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.modelMonitors.operations.html b/docs/dyn/aiplatform_v1beta1.modelMonitors.operations.html new file mode 100644 index 0000000000..0e1e3de92c --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.modelMonitors.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . modelMonitors . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.models.evaluations.html b/docs/dyn/aiplatform_v1beta1.models.evaluations.html new file mode 100644 index 0000000000..7ba1bc8644 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.models.evaluations.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . models . evaluations

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.models.evaluations.operations.html b/docs/dyn/aiplatform_v1beta1.models.evaluations.operations.html new file mode 100644 index 0000000000..29751a76d8 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.models.evaluations.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . models . evaluations . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.models.html b/docs/dyn/aiplatform_v1beta1.models.html new file mode 100644 index 0000000000..ce91977069 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.models.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . models

+

Instance Methods

+

+ evaluations() +

+

Returns the evaluations Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.models.operations.html b/docs/dyn/aiplatform_v1beta1.models.operations.html new file mode 100644 index 0000000000..5c100496f3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.models.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . models . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.html new file mode 100644 index 0000000000..9c014fd450 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . notebookExecutionJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.operations.html b/docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.operations.html new file mode 100644 index 0000000000..485424dafb --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.notebookExecutionJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . notebookExecutionJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.html b/docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.html new file mode 100644 index 0000000000..ca23fb3bb3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . notebookRuntimeTemplates

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.operations.html b/docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.operations.html new file mode 100644 index 0000000000..4bdff3e819 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.notebookRuntimeTemplates.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . notebookRuntimeTemplates . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.notebookRuntimes.html b/docs/dyn/aiplatform_v1beta1.notebookRuntimes.html new file mode 100644 index 0000000000..a16f0c5e17 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.notebookRuntimes.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . notebookRuntimes

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.notebookRuntimes.operations.html b/docs/dyn/aiplatform_v1beta1.notebookRuntimes.operations.html new file mode 100644 index 0000000000..f83d23c80f --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.notebookRuntimes.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . notebookRuntimes . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.operations.html b/docs/dyn/aiplatform_v1beta1.operations.html new file mode 100644 index 0000000000..5524b5161e --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  filter: string, The standard list filter.
+  name: string, The name of the operation's parent resource.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.persistentResources.html b/docs/dyn/aiplatform_v1beta1.persistentResources.html new file mode 100644 index 0000000000..d0db998b2c --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.persistentResources.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . persistentResources

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.persistentResources.operations.html b/docs/dyn/aiplatform_v1beta1.persistentResources.operations.html new file mode 100644 index 0000000000..aca5af4c17 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.persistentResources.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . persistentResources . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.pipelineJobs.html b/docs/dyn/aiplatform_v1beta1.pipelineJobs.html new file mode 100644 index 0000000000..5daeadeabf --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.pipelineJobs.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . pipelineJobs

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.pipelineJobs.operations.html b/docs/dyn/aiplatform_v1beta1.pipelineJobs.operations.html new file mode 100644 index 0000000000..caf92e5dfe --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.pipelineJobs.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . pipelineJobs . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 74f6eb2c7d..d80d3a7b6e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -112,52 +112,66 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -168,52 +182,66 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -234,6 +262,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -456,52 +490,66 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -512,52 +560,66 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -578,6 +640,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -825,52 +893,66 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -881,52 +963,66 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -947,6 +1043,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1180,52 +1282,66 @@

Method Details

"cachedContents": [ # List of cached contents. { # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -1236,52 +1352,66 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1302,6 +1432,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1543,52 +1679,66 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -1599,52 +1749,66 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1665,6 +1829,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1888,52 +2058,66 @@

Method Details

{ # A resource used in LLM queries for users to explicitly specify what to cache and how to cache. "contents": [ # Optional. Input only. Immutable. The content to cache - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "createTime": "A String", # Output only. Creation time of the cache entry. @@ -1944,52 +2128,66 @@

Method Details

"expireTime": "A String", # Timestamp of when this resource is considered expired. This is *always* provided on output, regardless of what was sent on input. "model": "A String", # Immutable. The name of the `Model` to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL} "name": "A String", # Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content} - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input only. Immutable. Developer set system instruction. Currently, text only + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Input only. Immutable. Tool config. This config is shared for all tools "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -2010,6 +2208,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 491cae7507..38c79fc6bb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -158,76 +158,95 @@

Method Details

"geminiExample": { # Format for Gemini examples used for Vertex Multimodal datasets. # Required. The template that will be used for assembling the request to use for downstream applications. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -266,103 +285,117 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, "model": "A String", # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -383,6 +416,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -643,76 +682,95 @@

Method Details

"geminiExample": { # Format for Gemini examples used for Vertex Multimodal datasets. # Required. The template that will be used for assembling the request to use for downstream applications. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -751,103 +809,117 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, "model": "A String", # Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -868,6 +940,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html index 3e2d6ea75f..bd7505ccdf 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.deploymentResourcePools.html @@ -157,7 +157,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -287,7 +287,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -356,7 +356,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -433,7 +433,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -543,7 +543,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 7774dc3b60..d21d2b33f5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -197,52 +197,66 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -285,76 +299,95 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -393,101 +426,121 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -701,9 +754,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -768,7 +821,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -1104,7 +1157,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -1844,76 +1897,95 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1952,106 +2024,120 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -2072,6 +2158,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -2286,184 +2378,198 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -2475,46 +2581,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -2585,7 +2691,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -2911,7 +3017,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -3160,7 +3266,7 @@

Method Details

The object takes the form of: { # Request message for EndpointService.MutateDeployedModel. - "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) + "deployedModel": { # A deployment of a Model. Endpoints contain one or more DeployedModels. # Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only) "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. "maxReplicaCount": 42, # Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. "minReplicaCount": 42, # Immutable. The minimum number of replicas that will be always deployed on. If traffic against it increases, it may dynamically be deployed onto more replicas up to max_replica_count, and as traffic decreases, some of these extra replicas may be freed. If the requested value is too large, the deployment will error. @@ -3200,7 +3306,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -3453,7 +3559,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -3731,7 +3837,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -3966,6 +4072,9 @@

Method Details

"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. "", ], + "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + "a_key": "A String", + }, "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. } @@ -4332,76 +4441,95 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -4440,106 +4568,120 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -4560,6 +4702,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -4774,184 +4922,198 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -4963,46 +5125,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -5176,7 +5338,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index 53d93b1a4b..28f1aa2b56 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -129,64 +129,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -246,64 +386,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -363,64 +643,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -480,64 +900,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -639,64 +1199,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -756,64 +1456,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -886,64 +1726,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, @@ -1003,64 +1983,204 @@

Method Details

"candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. + "events": [ # Optional. Intermediate events (such as tool calls and responses) that led to the final response. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], "text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. # Required. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. - "a_key": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 9cd3192e43..870eb8193d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -171,28 +171,33 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -231,45 +236,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -281,28 +286,33 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -341,45 +351,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -393,28 +403,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -453,45 +468,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -505,6 +520,287 @@

Method Details

"systemInstruction": "A String", # Optional. System instructions for the judge model. }, "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. + }, + }, "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -528,28 +824,33 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -588,45 +889,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -634,28 +935,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -694,45 +1000,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -769,28 +1075,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -829,45 +1140,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -894,126 +1205,405 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "modelConfig": { # Config for model selection. # Optional. Config for model selection. - "featureSelectionPreference": "A String", # Required. Feature selection preference. - }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. - "A String", - ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. - "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. - "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value of the data. - "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. - "A String", - ], - "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. }, }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, }, - }, - }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. - }, - "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - }, - }, - "labels": { # Optional. Labels for the evaluation run. - "a_key": "A String", - }, - "metadata": "", # Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run. - "name": "A String", # Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}` - "state": "A String", # Output only. The state of the evaluation run. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics. + "tools": [ # Optional. The tools available to the agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + }, + }, + "labels": { # Optional. Labels for the evaluation run. + "a_key": "A String", + }, + "metadata": "", # Optional. Metadata about the evaluation run, can be used by the caller to store additional tracking information about the evaluation run. + "name": "A String", # Identifier. The resource name of the EvaluationRun. This is a unique identifier. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}` + "state": "A String", # Output only. The state of the evaluation run. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # EvaluationRun is a resource that represents a single evaluation run, which includes a set of prompts, model responses, evaluation configuration and the resulting metrics. "completionTime": "A String", # Output only. Time when the evaluation run was completed. "createTime": "A String", # Output only. Time when the evaluation run was created. "dataSource": { # The data source for the evaluation run. # Required. The data source for the evaluation run. @@ -1045,28 +1635,33 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1075,108 +1670,651 @@

Method Details

"defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metrics": [ # Required. The metrics to be calculated in the evaluation run. + { # The metric used for evaluation runs. + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "parameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # Optional. The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. }, - "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. - "A String", - ], - "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "parameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricBasedMetricSpec": { # Specification for a metric that is based on rubrics. # Spec for rubric based metric. + "inlineRubrics": { # Defines a list of rubrics, used when providing rubrics inline. # Use rubrics provided directly in the spec. + "rubrics": [ # The list of rubrics. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." }, }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. - }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - }, - "metrics": [ # Required. The metrics to be calculated in the evaluation run. - { # The metric used for evaluation runs. - "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. - "additionalConfig": { # Optional. Optional additional configuration for the metric. - "a_key": "", # Properties of the object. - }, - "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). + "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1215,80 +2353,79 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. - "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. - "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - "parameters": { # Optional. The parameters needed to run the pre-defined metric. - "a_key": "", # Properties of the object. - }, - }, - "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "metricPromptTemplate": "A String", # Optional. Template for the prompt used by the judge model to evaluate against rubrics. + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1327,45 +2464,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1375,55 +2512,60 @@

Method Details

"A String", ], }, - "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - "systemInstruction": "A String", # Optional. System instructions for the judge model. + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`. }, - "metric": "A String", # Required. The name of the metric. - "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. + }, + ], + "outputConfig": { # The output config for the evaluation run. # Optional. The output config for the evaluation run. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery destination for evaluation output. + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud Storage destination for evaluation output. + "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + }, + }, + "promptTemplate": { # Prompt template used for inference. # The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, + "rubricConfigs": [ # Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation. + { # Configuration for a rubric group to be generated/saved for evaluation. + "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. "a_key": "", # Properties of the object. }, }, - "rubricBasedMetricSpec": { # Specification for a metric that is based on rubrics. # Spec for rubric based metric. - "inlineRubrics": { # Defines a list of rubrics, used when providing rubrics inline. # Use rubrics provided directly in the spec. - "rubrics": [ # The list of rubrics. - { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. - "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. - "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. - "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." - }, - }, - "importance": "A String", # Optional. The relative importance of this rubric. - "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. - "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". - }, - ], - }, - "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1462,74 +2604,154 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "metricPromptTemplate": "A String", # Optional. Template for the prompt used by the judge model to evaluate against rubrics. - "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. - "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. - "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "modelConfig": { # Config for model selection. # Optional. Config for model selection. - "featureSelectionPreference": "A String", # Required. Feature selection preference. + "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # Optional. The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation. + }, + ], + }, + "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. + "evaluationSet": "A String", # The evaluation set where item level results are stored. + "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run. + "failedItems": 42, # Optional. The number of items that failed to be evaluated. + "metrics": { # Optional. Map of metric name to metric value. + "a_key": "", + }, + "totalItems": 42, # Optional. The total number of items that were evaluated. + }, + }, + "evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. + "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. + "a_key": { # An inference config used for model inference during the evaluation run. + "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. - "A String", + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "tools": [ # Optional. The tools available to the agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1568,228 +2790,186 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema }, - }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. - }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - }, - "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - "rubricContentType": "A String", # Optional. The type of rubric content to be generated. - "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - "A String", - ], - }, - "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input content. This refers to a key in the `rubric_groups` map of `RubricEnhancedContents`. - }, - }, - ], - "outputConfig": { # The output config for the evaluation run. # Optional. The output config for the evaluation run. - "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery destination for evaluation output. - "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. - }, - "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud Storage destination for evaluation output. - "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. - }, - }, - "promptTemplate": { # Prompt template used for inference. # The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. - "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". - "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" - }, - "rubricConfigs": [ # Optional. The rubric configs for the evaluation run. They are used to generate rubrics which can be used by rubric-based metrics. Multiple rubric configs can be specified for rubric generation but only one rubric config can be used for a rubric-based metric. If more than one rubric config is provided, the evaluation metric must specify a rubric group key. Note that if a generation spec is specified on both a rubric config and an evaluation metric, the rubrics generated for the metric will be used for evaluation. - { # Configuration for a rubric group to be generated/saved for evaluation. - "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. - "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - "parameters": { # Optional. The parameters needed to run the pre-defined metric. - "a_key": "", # Properties of the object. - }, - }, - "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. - "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. - "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "modelConfig": { # Config for model selection. # Optional. Config for model selection. - "featureSelectionPreference": "A String", # Required. Feature selection preference. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. - "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. - "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value of the data. - "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, }, - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, }, - "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. - "A String", - ], - "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. }, + "topK": 42, # Optional. The number of contexts to retrieve. }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, }, - "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - "rubricContentType": "A String", # Optional. The type of rubric content to be generated. - "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - "A String", - ], - }, - "rubricGroupKey": "A String", # Required. The key used to save the generated rubrics. If a generation spec is provided, this key will be used for the name of the generated rubric group. Otherwise, this key will be used to look up the existing rubric group on the evaluation item. Note that if a rubric group key is specified on both a rubric config and an evaluation metric, the key from the metric will be used to select the rubrics for evaluation. - }, - ], - }, - "evaluationResults": { # The results of the evaluation run. # Output only. The results of the evaluation run. Only populated when the evaluation run's state is SUCCEEDED. - "evaluationSet": "A String", # The evaluation set where item level results are stored. - "summaryMetrics": { # The summary metrics for the evaluation run. # Optional. The summary metrics for the evaluation run. - "failedItems": 42, # Optional. The number of items that failed to be evaluated. - "metrics": { # Optional. Map of metric name to metric value. - "a_key": "", + ], }, - "totalItems": 42, # Optional. The total number of items that were evaluated. - }, - }, - "evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. - "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. - "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1828,45 +3008,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, @@ -1961,28 +3141,33 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2021,45 +3206,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2071,28 +3256,33 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2131,45 +3321,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2183,28 +3373,169 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # Optional. The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2243,58 +3574,203 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, }, }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. }, }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], }, - "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - "rubricContentType": "A String", # Optional. The type of rubric content to be generated. - "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - "A String", - ], + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. }, - "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - "systemInstruction": "A String", # Optional. System instructions for the judge model. }, - "metric": "A String", # Required. The name of the metric. "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -2318,28 +3794,33 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2378,45 +3859,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2424,28 +3905,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2484,45 +3970,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2559,28 +4045,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2619,45 +4110,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2684,28 +4175,307 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "tools": [ # Optional. The tools available to the agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2744,45 +4514,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, @@ -2848,28 +4618,33 @@

Method Details

"evaluationConfig": { # The Evalution configuration used for the evaluation run. # Required. The configuration used for the evaluation. "autoraterConfig": { # The autorater config used for the evaluation run. # Optional. The autorater config for the evaluation run. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2908,45 +4683,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2958,28 +4733,33 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -3018,80 +4798,221 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "parameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, }, }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. }, }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # Optional. The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], }, - "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. - "predefinedRubricGenerationSpec": { # Specification for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. - "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - "parameters": { # Optional. The parameters needed to run the pre-defined metric. + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "metric": "A String", # Required. The name of the metric. + "metricConfig": { # The metric used for running evaluations. # The metric config. + "aggregationMetrics": [ # Optional. The aggregation metrics to use. + "A String", + ], + "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. + "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. + }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, + "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. + }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. }, - }, - "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. - "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -3130,58 +5051,203 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, - "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, - "promptTemplate": "A String", # Optional. Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - "rubricContentType": "A String", # Optional. The type of rubric content to be generated. - "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - "A String", - ], + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "modelConfig": { # Config for model selection. # Optional. Config for model selection. + "featureSelectionPreference": "A String", # Required. Feature selection preference. + }, + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + ], + }, + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + }, + }, + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. + "A String", + ], + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. + }, + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. + }, + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, + "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. + "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. + "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. + "systemInstruction": "A String", # Optional. System instructions for pairwise metric. + }, + "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. + "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. + "returnRawOutput": True or False, # Optional. Whether to return raw output. + }, + "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. + "systemInstruction": "A String", # Optional. System instructions for pointwise metric. + }, + "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. + "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. + "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. + "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. }, - "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - "systemInstruction": "A String", # Optional. System instructions for the judge model. }, - "metric": "A String", # Required. The name of the metric. "predefinedMetricSpec": { # Specification for a pre-defined metric. # Spec for a pre-defined metric. "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". "parameters": { # Optional. The parameters needed to run the pre-defined metric. @@ -3205,28 +5271,33 @@

Method Details

}, "judgeAutoraterConfig": { # The autorater config used for the evaluation run. # Optional. Optional configuration for the judge LLM (Autorater). The definition of AutoraterConfig needs to be provided. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -3265,45 +5336,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3311,28 +5382,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics for evaluation using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -3371,45 +5447,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3446,28 +5522,33 @@

Method Details

"rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. "modelConfig": { # The autorater config used for the evaluation run. # Optional. Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -3506,45 +5587,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3571,28 +5652,307 @@

Method Details

"evaluationSetSnapshot": "A String", # Output only. The specific evaluation set of the evaluation run. For runs with an evaluation set input, this will be that same set. For runs with BigQuery input, it's the sampled BigQuery dataset. "inferenceConfigs": { # Optional. The candidate to inference config map for the evaluation run. The candidate can be up to 128 characters long and can consist of any UTF-8 characters. "a_key": { # An inference config used for model inference during the evaluation run. - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "agentConfig": { # Configuration that describes an agent. # Optional. Agent config used to generate responses. + "developerInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The developer instruction for the agent. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "tools": [ # Optional. The tools available to the agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -3631,45 +5991,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 3567382826..84305501ad 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -242,102 +242,130 @@

Method Details

"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent. "contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent. "contents": [ # Required. The content of the conversation with the model that resulted in the expected output. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "expectedContents": [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output. { # A single step of the expected output. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. A single step's content. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -546,52 +574,66 @@

Method Details

"storedContentsExampleParameters": { # The metadata filters that will be used to search StoredContentsExamples. If a field is unspecified, then no filtering for that field will be applied # The parameters of StoredContentsExamples to be searched. "contentSearchKey": { # The chat history to use to generate the search key for retrieval. # The chat history to use to generate the search key for retrieval. "contents": [ # Required. The conversation for generating a search key. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "searchKeyGenerationMethod": { # Options for generating the search key from the conversation history. # Required. The method of generating a search key. @@ -628,102 +670,130 @@

Method Details

"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent. "contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent. "contents": [ # Required. The content of the conversation with the model that resulted in the expected output. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "expectedContents": [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output. { # A single step of the expected output. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. A single step's content. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -759,102 +829,130 @@

Method Details

"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent. "contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent. "contents": [ # Required. The content of the conversation with the model that resulted in the expected output. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "expectedContents": [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output. { # A single step of the expected output. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. A single step's content. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -888,102 +986,130 @@

Method Details

"storedContentsExample": { # A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store. # An example of chat history and its expected outcome to be used with GenerateContent. "contentsExample": { # A single example of a conversation with the model. # Required. The example to be used with GenerateContent. "contents": [ # Required. The content of the conversation with the model that resulted in the expected output. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "expectedContents": [ # Required. The expected output for the given `contents`. To represent multi-step reasoning, this is a repeated field that contains the iterative steps of the expected output. { # A single step of the expected output. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. A single step's content. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single step's content. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 0f67f9567a..f572b3daab 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1145,52 +1145,66 @@

Method Details

{ # Request message for ExtensionExecutionService.QueryExtension. "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], } @@ -1206,52 +1220,66 @@

Method Details

{ # Response message for ExtensionExecutionService.QueryExtension. "failureMessage": "A String", # Failure message if any. "steps": [ # Steps of extension or LLM interaction, can contain function call, function response, or text response. The last step contains the final response to the query. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 401f455ee6..3b49a0eb13 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -364,52 +364,66 @@

Method Details

{ # Request message for AugmentPrompt. "contents": [ # Optional. Input content to augment, only text format is supported for now. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "model": { # Metadata of the backend deployed model. # Optional. Metadata of the backend deployed model. @@ -463,52 +477,66 @@

Method Details

{ # Response message for AugmentPrompt. "augmentedPrompt": [ # Augmented prompt, only text format is supported for now. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "facts": [ # Retrieved facts from RAG data sources. @@ -546,52 +574,66 @@

Method Details

The object takes the form of: { # Request message for CorroborateContent. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Input content to corroborate, only text format is supported for now. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Input content to corroborate, only text format is supported for now. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "facts": [ # Optional. Facts used to generate the text can also be used to corroborate the text. { # The fact used in grounding. @@ -686,7 +728,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -933,7 +975,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -986,28 +1028,33 @@

Method Details

"autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config used for evaluation. Currently only publisher Gemini models are supported. Format: `projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}.` "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1046,45 +1093,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1106,6 +1153,9 @@

Method Details

"bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. @@ -1115,28 +1165,33 @@

Method Details

"judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1175,45 +1230,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1228,28 +1283,33 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1288,45 +1348,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1417,28 +1477,33 @@

Method Details

"autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config used for evaluation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1477,45 +1542,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1587,57 +1652,705 @@

Method Details

}, }, "instance": { # A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations # The instance to be evaluated. + "agentData": { # Contains data specific to agent evaluations. # Optional. Data used for agent evaluation. + "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. A field containing instructions from the developer for the agent. + "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. + "contents": [ # Optional. Repeated contents. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "text": "A String", # Text data. + }, + "tools": { # Represents a list of tools for an agent. # List of tools. + "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. + }, + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. A field containing instructions from the developer for the agent. + "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. + "contents": [ # Optional. Repeated contents. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "text": "A String", # Text data. + }, + "events": { # Represents a list of events for an agent. # A list of events. + "event": [ # Optional. A list of events. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "eventsText": "A String", # A JSON string containing a sequence of events. + "tools": { # Represents a list of tools for an agent. # List of tools. + "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { "name": "search_actors", "description": "Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.", "parameters": [ { "name": "movie_name", "description": "The name of the movie." }, { "name": "character_name", "description": "The name of the character." } ], "required": ["movie_name", "character_name"] } ] + }, "otherData": { # Instance data specified as a map. # Optional. Other data used to populate placeholders based on their key. "mapInstance": { # Optional. Map of instance data. "a_key": { # Instance data used to populate placeholders in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1648,52 +2361,66 @@

Method Details

"prompt": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Data used to populate placeholder `prompt` in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1702,52 +2429,66 @@

Method Details

"reference": { # Instance data used to populate placeholders in a metric prompt template. # Optional. Data used to populate placeholder `reference` in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1756,52 +2497,66 @@

Method Details

"response": { # Instance data used to populate placeholders in a metric prompt template. # Required. Data used to populate placeholder `response` in a metric prompt template. "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -1834,6 +2589,9 @@

Method Details

"bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. @@ -1843,28 +2601,33 @@

Method Details

"judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1903,45 +2666,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -1956,28 +2719,33 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2016,45 +2784,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -2114,52 +2882,66 @@

Method Details

"values": { # Optional. Map of placeholder to contents. "a_key": { # Repeated Content type. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -2209,52 +2991,66 @@

Method Details

"values": { # Optional. Map of placeholder to contents. "a_key": { # Repeated Content type. "contents": [ # Optional. Repeated contents. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -2813,53 +3609,351 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateInstanceRubrics. + "agentConfig": { # Configuration for an Agent. # Optional. Agent configuration, required for agent-based rubric generation. + "developerInstruction": { # Instance data used to populate placeholders in a metric prompt template. # Optional. A field containing instructions from the developer for the agent. + "contents": { # List of standard Content messages from Gemini API. # List of Gemini content data. + "contents": [ # Optional. Repeated contents. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + ], + }, + "text": "A String", # Text data. + }, + "tools": { # Represents a list of tools for an agent. # List of tools. + "tool": [ # Optional. List of tools: each tool can have multiple function declarations. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. + "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. + # Object with schema name: GoogleCloudAiplatformV1beta1Schema + ], + "default": "", # Optional. Default value of the data. + "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "A String", + ], + "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. + "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybridSearch": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "storeContext": True or False, # Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + "toolsText": "A String", # A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. + }, "contents": [ # Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Optional. Specification for using the rubric generation configs of a pre-defined metric, e.g. "generic_quality_v1" and "instruction_following_v1". Some of the configs may be only used in rubric generation and not supporting evaluation, e.g. "fully_customized_generic_quality_v1". If this field is set, the `rubric_generation_spec` field will be ignored. @@ -2872,28 +3966,33 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2932,45 +4031,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -3021,52 +4120,66 @@

Method Details

{ # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. "fields": [ # Required. A list of fields that constitute an example. { # Represents a single named field within a SyntheticExample. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the field. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the field. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "fieldName": "A String", # Optional. The name of the field. }, @@ -3098,52 +4211,66 @@

Method Details

{ # Represents a single synthetic example, composed of multiple fields. Used for providing few-shot examples in the request and for returning generated examples in the response. "fields": [ # Required. A list of fields that constitute an example. { # Represents a single named field within a SyntheticExample. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the field. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the field. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "fieldName": "A String", # Optional. The name of the field. }, @@ -3199,9 +4326,9 @@

Method Details

"ragManagedDbConfig": { # Configuration message for RagManagedDb used by RagEngine. # The config of the RagManagedDb used by RagEngine. "basic": { # Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen. # Sets the RagManagedDb to the Basic tier. }, - "enterprise": { # Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Enterprise tier. This is the default tier if not explicitly chosen. + "enterprise": { # Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Enterprise tier. }, - "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. + "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen. }, "unprovisioned": { # Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API. # Sets the RagManagedDb to the Unprovisioned tier. }, @@ -3215,7 +4342,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. @@ -3678,9 +4805,9 @@

Method Details

"ragManagedDbConfig": { # Configuration message for RagManagedDb used by RagEngine. # The config of the RagManagedDb used by RagEngine. "basic": { # Basic tier is a cost-effective and low compute tier suitable for the following cases: * Experimenting with RagManagedDb. * Small data size. * Latency insensitive workload. * Only using RAG Engine with external vector DBs. NOTE: This is the default tier if not explicitly chosen. # Sets the RagManagedDb to the Basic tier. }, - "enterprise": { # Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Enterprise tier. This is the default tier if not explicitly chosen. + "enterprise": { # Enterprise tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Enterprise tier. }, - "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. + "scaled": { # Scaled tier offers production grade performance along with autoscaling functionality. It is suitable for customers with large amounts of data or performance sensitive workloads. # Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen. }, "unprovisioned": { # Disables the RAG Engine service and deletes all your data held within this service. This will halt the billing of the service. NOTE: Once deleted the data cannot be recovered. To start using RAG Engine again, you will need to update the tier by calling the UpdateRagEngineConfig API. # Sets the RagManagedDb to the Unprovisioned tier. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html index c25000316d..f093a2c1d4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.indexEndpoints.html @@ -172,7 +172,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -371,7 +371,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -634,7 +634,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -783,7 +783,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -935,7 +935,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -1064,7 +1064,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -1201,7 +1201,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index d09592ddbe..cb2ee9cf46 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -83,6 +83,9 @@

Instance Methods

countTokens(endpoint, body=None, x__xgafv=None)

Perform a token counting.

+

+ embedContent(model, body=None, x__xgafv=None)

+

Embed content with multimodal inputs.

export(parent, name, body=None, x__xgafv=None)

Exports a publisher model to a user provided Google Cloud Storage bucket.

@@ -136,52 +139,66 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -224,76 +241,95 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -332,101 +368,121 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -640,9 +696,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -650,6 +706,134 @@

Method Details

}
+
+ embedContent(model, body=None, x__xgafv=None) + 
Embed content with multimodal inputs.
+
+Args:
+  model: string, Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.EmbedContent.
+  "autoTruncate": True or False, # Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.
+  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. Input content to be embedded. Required.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+          "outcome": "A String", # Required. Outcome of the code execution.
+          "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+        },
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+          "code": "A String", # Required. The code to be executed.
+          "language": "A String", # Required. Programming language of the `code`.
+        },
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+          "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+            "a_key": "", # Properties of the object.
+          },
+          "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+          "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
+        },
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+          "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+          "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
+          "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+        },
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+        "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "endOffset": "A String", # Optional. The end offset of the video.
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+          "startOffset": "A String", # Optional. The start offset of the video.
+        },
+      },
+    ],
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+  },
+  "outputDimensionality": 42, # Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
+  "taskType": "A String", # Optional. The task type of the embedding.
+  "title": "A String", # Optional. An optional title for the text.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for PredictionService.EmbedContent.
+  "embedding": { # A list of floats representing an embedding. # The embedding generated from the input content.
+    "values": [ # Embedding vector values.
+      3.14,
+    ],
+  },
+  "truncated": True or False, # Whether the input content was truncated before generating the embedding.
+  "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Metadata about the response(s).
+    "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
+    "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
+    "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
+    "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
+    "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
+    "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
+      },
+    ],
+    "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
+    "trafficType": "A String", # Output only. The traffic type for this request.
+  },
+}
+
+
export(parent, name, body=None, x__xgafv=None) 
Exports a publisher model to a user provided Google Cloud Storage bucket.
@@ -776,76 +960,95 @@ 
Method Details

 { # Request message for [PredictionService.GenerateContent].
   "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
   "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
-    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
             "outcome": "A String", # Required. Outcome of the code execution.
             "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
           },
-          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
             "code": "A String", # Required. The code to be executed.
             "language": "A String", # Required. Programming language of the `code`.
           },
-          "fileData": { # URI based data. # Optional. URI based data.
-            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-            "fileUri": "A String", # Required. URI.
+          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
             "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
               "a_key": "", # Properties of the object.
             },
             "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
             "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
           },
-          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
             "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
             "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                "fileData": { # URI based data for function response. # URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+              },
+            ],
             "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
               "a_key": "", # Properties of the object.
             },
           },
-          "inlineData": { # Content blob. # Optional. Inlined bytes data.
-            "data": "A String", # Required. Raw bytes.
-            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+            "data": "A String", # Required. The raw bytes of the data.
+            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "text": "A String", # Optional. Text part (can be code).
-          "thought": True or False, # Optional. Indicates if the part is thought from the model.
+          "text": "A String", # Optional. The text content of the part.
+          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
           "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
             "endOffset": "A String", # Optional. The end offset of the video.
-            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
             "startOffset": "A String", # Optional. The start offset of the video.
           },
         },
       ],
-      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
     },
   ],
-  "generationConfig": { # Generation config. # Optional. Generation config.
-    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-    "candidateCount": 42, # Optional. Number of candidates to generate.
-    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-    "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+  "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config.
+    "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+    "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+    "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+    "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
       "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+      "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+        "compressionQuality": 42, # Optional. The compression quality of the output image.
+        "mimeType": "A String", # Optional. The image format that the output should be saved as.
+      },
+      "personGeneration": "A String", # Optional. Controls whether the model can generate people.
     },
-    "logprobs": 42, # Optional. Logit probabilities.
-    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+    "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+    "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+    "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
     "modelConfig": { # Config for model selection. # Optional. Config for model selection.
       "featureSelectionPreference": "A String", # Required. Feature selection preference.
     },
-    "presencePenalty": 3.14, # Optional. Positive penalties.
-    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-    "responseModalities": [ # Optional. The modalities of the response.
+    "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+    "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+    "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+    "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+    "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
       "A String",
     ],
-    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
       "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
       "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
         # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -884,106 +1087,120 @@ 
Method Details

       "title": "A String", # Optional. The title of the Schema.
       "type": "A String", # Optional. The type of the data.
     },
-    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+    "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+      "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
         "modelRoutingPreference": "A String", # The model routing preference.
       },
-      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+      "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+        "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
       },
     },
-    "seed": 42, # Optional. Seed.
-    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+    "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+    "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+      "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
         "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-          { # Configuration for a single speaker in a multi speaker setup.
+          { # Configuration for a single speaker in a multi-speaker setup.
             "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-            "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
         ],
       },
-      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-          "voiceName": "A String", # The name of the preset voice to use.
+      "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+          "voiceName": "A String", # The name of the prebuilt voice to use.
         },
       },
     },
-    "stopSequences": [ # Optional. Stop sequences.
+    "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
       "A String",
     ],
-    "temperature": 3.14, # Optional. Controls the randomness of predictions.
-    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+    "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+    "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+      "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+      "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
     },
-    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+    "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+    "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
   },
   "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
     "a_key": "A String",
   },
-  "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
-    "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
-    "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+  "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+    "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+    "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
   },
   "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
-    { # Safety settings.
-      "category": "A String", # Required. Harm category.
-      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
-      "threshold": "A String", # Required. The harm block threshold.
+    { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
+      "category": "A String", # Required. The harm category to be blocked.
+      "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.
+      "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.
     },
   ],
-  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
   "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
     "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
@@ -1004,6 +1221,12 @@ 
Method Details

     { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
       "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
       },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
       "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
         "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
         "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
@@ -1218,184 +1441,198 @@ 
Method Details

     { # Response message for [PredictionService.GenerateContent].
   "candidates": [ # Output only. Generated candidates.
     { # A response candidate generated from the model.
-      "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
-      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
-        "citations": [ # Output only. List of citations.
-          { # Source attributions for content.
-            "endIndex": 42, # Output only. End index into the content.
-            "license": "A String", # Output only. License of the attribution.
-            "publicationDate": { # 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 # Output only. Publication date of the attribution.
+      "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.
+      "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content.
+        "citations": [ # Output only. A list of citations for the content.
+          { # A citation for a piece of generatedcontent.
+            "endIndex": 42, # Output only. The end index of the citation in the content.
+            "license": "A String", # Output only. The license of the source of the citation.
+            "publicationDate": { # 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 # Output only. The publication date of the source of the citation.
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
               "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
             },
-            "startIndex": 42, # Output only. Start index into the content.
-            "title": "A String", # Output only. Title of the attribution.
-            "uri": "A String", # Output only. Url reference of the attribution.
+            "startIndex": 42, # Output only. The start index of the citation in the content.
+            "title": "A String", # Output only. The title of the source of the citation.
+            "uri": "A String", # Output only. The URI of the source of the citation.
           },
         ],
       },
-      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
-        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
               "outcome": "A String", # Required. Outcome of the code execution.
               "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
             },
-            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
               "code": "A String", # Required. The code to be executed.
               "language": "A String", # Required. Programming language of the `code`.
             },
-            "fileData": { # URI based data. # Optional. URI based data.
-              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-              "fileUri": "A String", # Required. URI.
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
               "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                 "a_key": "", # Properties of the object.
               },
               "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
               "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
             },
-            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
               "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
               "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
               "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                 "a_key": "", # Properties of the object.
               },
             },
-            "inlineData": { # Content blob. # Optional. Inlined bytes data.
-              "data": "A String", # Required. Raw bytes.
-              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "text": "A String", # Optional. Text part (can be code).
-            "thought": True or False, # Optional. Indicates if the part is thought from the model.
+            "text": "A String", # Optional. The text content of the part.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
             "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
               "endOffset": "A String", # Optional. The end offset of the video.
-              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
               "startOffset": "A String", # Optional. The start offset of the video.
             },
           },
         ],
-        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-      },
-      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
-      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
-      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
-        "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-        "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-          { # Grounding chunk.
-            "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-              "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                  { # Encapsulates a review snippet.
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.
+      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.
+      "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.
+        "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+        "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+          { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+            "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+              "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                  { # A review snippet that is used to generate the answer.
                     "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                    "reviewId": "A String", # Id of the review referencing the place.
-                    "title": "A String", # Title of the review.
+                    "reviewId": "A String", # The ID of the review that is being referenced.
+                    "title": "A String", # The title of the review.
                   },
                 ],
               },
-              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-              "text": "A String", # Text of the place answer.
-              "title": "A String", # Title of the place.
-              "uri": "A String", # URI reference of the place.
-            },
-            "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-              "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+              "text": "A String", # The text of the place answer.
+              "title": "A String", # The title of the place.
+              "uri": "A String", # The URI of the place.
+            },
+            "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+              "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
                 "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                   "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                   "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                 },
                 "text": "A String", # The content of the chunk.
               },
-              "text": "A String", # Text of the attribution.
-              "title": "A String", # Title of the attribution.
-              "uri": "A String", # URI reference of the attribution.
+              "text": "A String", # The content of the retrieved data source.
+              "title": "A String", # The title of the retrieved data source.
+              "uri": "A String", # The URI of the retrieved data source.
             },
-            "web": { # Chunk from the web. # Grounding chunk from the web.
-              "domain": "A String", # Domain of the (original) URI.
-              "title": "A String", # Title of the chunk.
-              "uri": "A String", # URI reference of the chunk.
+            "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+              "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+              "title": "A String", # The title of the web page that contains the evidence.
+              "uri": "A String", # The URI of the web page that contains the evidence.
             },
           },
         ],
-        "groundingSupports": [ # Optional. List of grounding support.
-          { # Grounding support.
-            "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+        "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+          { # A collection of supporting references for a segment of the model's response.
+            "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
               3.14,
             ],
-            "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+            "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
               42,
             ],
-            "segment": { # Segment of the content. # Segment of the content this support belongs to.
-              "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-              "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-              "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-              "text": "A String", # Output only. The text corresponding to the segment from the response.
+            "segment": { # A segment of the content. # The content segment that this support message applies to.
+              "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+              "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+              "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+              "text": "A String", # Output only. The text of the segment.
             },
           },
         ],
-        "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-          "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+        "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+          "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
         },
-        "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+        "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
           "A String",
         ],
-        "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-          "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-          "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+        "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+          "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+          "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
         },
-        "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-          { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-            "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-            "sourceId": "A String", # Id of the place or review.
+        "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+          { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+            "flagContentUri": "A String", # The URI that can be used to flag the content.
+            "sourceId": "A String", # The ID of the place or review.
           },
         ],
-        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+        "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
           "A String",
         ],
       },
-      "index": 42, # Output only. Index of the candidate.
-      "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
-        "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
-          { # Candidate for the logprobs token and score.
-            "logProbability": 3.14, # The candidate's log probability.
-            "token": "A String", # The candidate's token string value.
-            "tokenId": 42, # The candidate's token id value.
+      "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.
+      "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".
+        "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.
+          { # A single token and its associated log probability.
+            "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+            "token": "A String", # The token's string representation.
+            "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
           },
         ],
-        "topCandidates": [ # Length = total number of decoding steps.
-          { # Candidates with top log probabilities at each decoding step.
-            "candidates": [ # Sorted by log probability in descending order.
-              { # Candidate for the logprobs token and score.
-                "logProbability": 3.14, # The candidate's log probability.
-                "token": "A String", # The candidate's token string value.
-                "tokenId": 42, # The candidate's token id value.
+        "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.
+          { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.
+            "candidates": [ # The list of candidate tokens, sorted by log probability in descending order.
+              { # A single token and its associated log probability.
+                "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+                "token": "A String", # The token's string representation.
+                "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
               },
             ],
           },
         ],
       },
-      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
-        { # Safety rating corresponding to the generated content.
-          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-          "category": "A String", # Output only. Harm category.
+      "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
+        { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+          "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+          "category": "A String", # Output only. The harm category of this rating.
           "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-          "probability": "A String", # Output only. Harm probability levels in the content.
-          "probabilityScore": 3.14, # Output only. Harm probability score.
-          "severity": "A String", # Output only. Harm severity levels in the content.
-          "severityScore": 3.14, # Output only. Harm severity score.
+          "probability": "A String", # Output only. The probability of harm for this category.
+          "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+          "severity": "A String", # Output only. The severity of harm for this category.
+          "severityScore": 3.14, # Output only. The severity score of harm for this category.
         },
       ],
-      "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool.
-        "urlMetadata": [ # Output only. List of url context.
-          { # Context of the a single url retrieval.
-            "retrievedUrl": "A String", # Retrieved url by the tool.
-            "urlRetrievalStatus": "A String", # Status of the url retrieval.
+      "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
+        "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.
+          { # The metadata for a single URL retrieval.
+            "retrievedUrl": "A String", # The URL retrieved by the tool.
+            "urlRetrievalStatus": "A String", # The status of the URL retrieval.
           },
         ],
       },
@@ -1407,46 +1644,46 @@ 
Method Details

     "blockReason": "A String", # Output only. The reason why the prompt was blocked.
     "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked.
     "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category.
-      { # Safety rating corresponding to the generated content.
-        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-        "category": "A String", # Output only. Harm category.
+      { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+        "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+        "category": "A String", # Output only. The harm category of this rating.
         "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-        "probability": "A String", # Output only. Harm probability levels in the content.
-        "probabilityScore": 3.14, # Output only. Harm probability score.
-        "severity": "A String", # Output only. Harm severity levels in the content.
-        "severityScore": 3.14, # Output only. Harm severity score.
+        "probability": "A String", # Output only. The probability of harm for this category.
+        "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+        "severity": "A String", # Output only. The severity of harm for this category.
+        "severityScore": 3.14, # Output only. The severity score of harm for this category.
       },
     ],
   },
   "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id.
   "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s).
     "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
     "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
     "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
     "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
     "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
     "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
@@ -1503,6 +1740,9 @@ 
Method Details

   "instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri.
     "",
   ],
+  "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.
+    "a_key": "A String",
+  },
   "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.
 }
 
@@ -1863,76 +2103,95 @@ 
Method Details

 { # Request message for [PredictionService.GenerateContent].
   "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
   "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
-    { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+    { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
             "outcome": "A String", # Required. Outcome of the code execution.
             "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
           },
-          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
             "code": "A String", # Required. The code to be executed.
             "language": "A String", # Required. Programming language of the `code`.
           },
-          "fileData": { # URI based data. # Optional. URI based data.
-            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-            "fileUri": "A String", # Required. URI.
+          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
             "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
               "a_key": "", # Properties of the object.
             },
             "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
             "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
           },
-          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
             "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
             "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                "fileData": { # URI based data for function response. # URI based data.
+                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "fileUri": "A String", # Required. URI.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                  "data": "A String", # Required. Raw bytes.
+                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+              },
+            ],
             "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
               "a_key": "", # Properties of the object.
             },
           },
-          "inlineData": { # Content blob. # Optional. Inlined bytes data.
-            "data": "A String", # Required. Raw bytes.
-            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+            "data": "A String", # Required. The raw bytes of the data.
+            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
           },
-          "text": "A String", # Optional. Text part (can be code).
-          "thought": True or False, # Optional. Indicates if the part is thought from the model.
+          "text": "A String", # Optional. The text content of the part.
+          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
           "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
             "endOffset": "A String", # Optional. The end offset of the video.
-            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
             "startOffset": "A String", # Optional. The start offset of the video.
           },
         },
       ],
-      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
     },
   ],
-  "generationConfig": { # Generation config. # Optional. Generation config.
-    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-    "candidateCount": 42, # Optional. Number of candidates to generate.
-    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-    "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+  "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config.
+    "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+    "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+    "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+    "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
       "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+      "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+        "compressionQuality": 42, # Optional. The compression quality of the output image.
+        "mimeType": "A String", # Optional. The image format that the output should be saved as.
+      },
+      "personGeneration": "A String", # Optional. Controls whether the model can generate people.
     },
-    "logprobs": 42, # Optional. Logit probabilities.
-    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+    "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+    "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+    "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
     "modelConfig": { # Config for model selection. # Optional. Config for model selection.
       "featureSelectionPreference": "A String", # Required. Feature selection preference.
     },
-    "presencePenalty": 3.14, # Optional. Positive penalties.
-    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-    "responseModalities": [ # Optional. The modalities of the response.
+    "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+    "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+    "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+    "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+    "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
       "A String",
     ],
-    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
       "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
       "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
         # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1971,106 +2230,120 @@ 
Method Details

       "title": "A String", # Optional. The title of the Schema.
       "type": "A String", # Optional. The type of the data.
     },
-    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+    "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+      "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
         "modelRoutingPreference": "A String", # The model routing preference.
       },
-      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+      "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+        "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
       },
     },
-    "seed": 42, # Optional. Seed.
-    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+    "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+    "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+      "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
         "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-          { # Configuration for a single speaker in a multi speaker setup.
+          { # Configuration for a single speaker in a multi-speaker setup.
             "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-            "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
         ],
       },
-      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-          "voiceName": "A String", # The name of the preset voice to use.
+      "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+          "voiceName": "A String", # The name of the prebuilt voice to use.
         },
       },
     },
-    "stopSequences": [ # Optional. Stop sequences.
+    "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
       "A String",
     ],
-    "temperature": 3.14, # Optional. Controls the randomness of predictions.
-    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+    "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+    "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+      "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+      "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
     },
-    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+    "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+    "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
   },
   "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
     "a_key": "A String",
   },
-  "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
-    "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization.
-    "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization.
+  "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied.
+    "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
+    "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.
   },
   "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
-    { # Safety settings.
-      "category": "A String", # Required. Harm category.
-      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
-      "threshold": "A String", # Required. The harm block threshold.
+    { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.
+      "category": "A String", # Required. The harm category to be blocked.
+      "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.
+      "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.
     },
   ],
-  "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
   "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request.
     "functionCallingConfig": { # Function calling config. # Optional. Function calling config.
@@ -2091,6 +2364,12 @@ 
Method Details

     { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
       "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
       },
+      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+        "environment": "A String", # Required. The environment being operated.
+        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+          "A String",
+        ],
+      },
       "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
         "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
         "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
@@ -2305,184 +2584,198 @@ 
Method Details

     { # Response message for [PredictionService.GenerateContent].
   "candidates": [ # Output only. Generated candidates.
     { # A response candidate generated from the model.
-      "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate.
-      "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content.
-        "citations": [ # Output only. List of citations.
-          { # Source attributions for content.
-            "endIndex": 42, # Output only. End index into the content.
-            "license": "A String", # Output only. License of the attribution.
-            "publicationDate": { # 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 # Output only. Publication date of the attribution.
+      "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.
+      "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content.
+        "citations": [ # Output only. A list of citations for the content.
+          { # A citation for a piece of generatedcontent.
+            "endIndex": 42, # Output only. The end index of the citation in the content.
+            "license": "A String", # Output only. The license of the source of the citation.
+            "publicationDate": { # 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 # Output only. The publication date of the source of the citation.
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
               "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
             },
-            "startIndex": 42, # Output only. Start index into the content.
-            "title": "A String", # Output only. Title of the attribution.
-            "uri": "A String", # Output only. Url reference of the attribution.
+            "startIndex": 42, # Output only. The start index of the citation in the content.
+            "title": "A String", # Output only. The title of the source of the citation.
+            "uri": "A String", # Output only. The URI of the source of the citation.
           },
         ],
       },
-      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate.
-        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
               "outcome": "A String", # Required. Outcome of the code execution.
               "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
             },
-            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
               "code": "A String", # Required. The code to be executed.
               "language": "A String", # Required. Programming language of the `code`.
             },
-            "fileData": { # URI based data. # Optional. URI based data.
-              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-              "fileUri": "A String", # Required. URI.
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
               "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                 "a_key": "", # Properties of the object.
               },
               "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
               "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
             },
-            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
               "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
               "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
               "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                 "a_key": "", # Properties of the object.
               },
             },
-            "inlineData": { # Content blob. # Optional. Inlined bytes data.
-              "data": "A String", # Required. Raw bytes.
-              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "text": "A String", # Optional. Text part (can be code).
-            "thought": True or False, # Optional. Indicates if the part is thought from the model.
+            "text": "A String", # Optional. The text content of the part.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
             "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
               "endOffset": "A String", # Optional. The end offset of the video.
-              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
               "startOffset": "A String", # Optional. The start offset of the video.
             },
           },
         ],
-        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-      },
-      "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.
-      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
-      "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content.
-        "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-        "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-          { # Grounding chunk.
-            "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-              "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                  { # Encapsulates a review snippet.
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+      },
+      "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.
+      "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.
+      "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.
+        "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+        "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+          { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+            "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+              "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                  { # A review snippet that is used to generate the answer.
                     "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                    "reviewId": "A String", # Id of the review referencing the place.
-                    "title": "A String", # Title of the review.
+                    "reviewId": "A String", # The ID of the review that is being referenced.
+                    "title": "A String", # The title of the review.
                   },
                 ],
               },
-              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-              "text": "A String", # Text of the place answer.
-              "title": "A String", # Title of the place.
-              "uri": "A String", # URI reference of the place.
-            },
-            "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-              "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+              "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+              "text": "A String", # The text of the place answer.
+              "title": "A String", # The title of the place.
+              "uri": "A String", # The URI of the place.
+            },
+            "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+              "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+              "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
                 "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                   "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                   "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                 },
                 "text": "A String", # The content of the chunk.
               },
-              "text": "A String", # Text of the attribution.
-              "title": "A String", # Title of the attribution.
-              "uri": "A String", # URI reference of the attribution.
+              "text": "A String", # The content of the retrieved data source.
+              "title": "A String", # The title of the retrieved data source.
+              "uri": "A String", # The URI of the retrieved data source.
             },
-            "web": { # Chunk from the web. # Grounding chunk from the web.
-              "domain": "A String", # Domain of the (original) URI.
-              "title": "A String", # Title of the chunk.
-              "uri": "A String", # URI reference of the chunk.
+            "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+              "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+              "title": "A String", # The title of the web page that contains the evidence.
+              "uri": "A String", # The URI of the web page that contains the evidence.
             },
           },
         ],
-        "groundingSupports": [ # Optional. List of grounding support.
-          { # Grounding support.
-            "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+        "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+          { # A collection of supporting references for a segment of the model's response.
+            "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
               3.14,
             ],
-            "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+            "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
               42,
             ],
-            "segment": { # Segment of the content. # Segment of the content this support belongs to.
-              "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-              "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-              "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-              "text": "A String", # Output only. The text corresponding to the segment from the response.
+            "segment": { # A segment of the content. # The content segment that this support message applies to.
+              "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+              "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+              "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+              "text": "A String", # Output only. The text of the segment.
             },
           },
         ],
-        "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-          "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+        "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+          "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
         },
-        "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+        "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
           "A String",
         ],
-        "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-          "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-          "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+        "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+          "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+          "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
         },
-        "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-          { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-            "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-            "sourceId": "A String", # Id of the place or review.
+        "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+          { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+            "flagContentUri": "A String", # The URI that can be used to flag the content.
+            "sourceId": "A String", # The ID of the place or review.
           },
         ],
-        "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+        "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
           "A String",
         ],
       },
-      "index": 42, # Output only. Index of the candidate.
-      "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens
-        "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.
-          { # Candidate for the logprobs token and score.
-            "logProbability": 3.14, # The candidate's log probability.
-            "token": "A String", # The candidate's token string value.
-            "tokenId": 42, # The candidate's token id value.
+      "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.
+      "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations".
+        "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.
+          { # A single token and its associated log probability.
+            "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+            "token": "A String", # The token's string representation.
+            "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
           },
         ],
-        "topCandidates": [ # Length = total number of decoding steps.
-          { # Candidates with top log probabilities at each decoding step.
-            "candidates": [ # Sorted by log probability in descending order.
-              { # Candidate for the logprobs token and score.
-                "logProbability": 3.14, # The candidate's log probability.
-                "token": "A String", # The candidate's token string value.
-                "tokenId": 42, # The candidate's token id value.
+        "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.
+          { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.
+            "candidates": [ # The list of candidate tokens, sorted by log probability in descending order.
+              { # A single token and its associated log probability.
+                "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.
+                "token": "A String", # The token's string representation.
+                "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.
               },
             ],
           },
         ],
       },
-      "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
-        { # Safety rating corresponding to the generated content.
-          "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-          "category": "A String", # Output only. Harm category.
+      "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.
+        { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+          "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+          "category": "A String", # Output only. The harm category of this rating.
           "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-          "probability": "A String", # Output only. Harm probability levels in the content.
-          "probabilityScore": 3.14, # Output only. Harm probability score.
-          "severity": "A String", # Output only. Harm severity levels in the content.
-          "severityScore": 3.14, # Output only. Harm severity score.
+          "probability": "A String", # Output only. The probability of harm for this category.
+          "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+          "severity": "A String", # Output only. The severity of harm for this category.
+          "severityScore": 3.14, # Output only. The severity score of harm for this category.
         },
       ],
-      "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool.
-        "urlMetadata": [ # Output only. List of url context.
-          { # Context of the a single url retrieval.
-            "retrievedUrl": "A String", # Retrieved url by the tool.
-            "urlRetrievalStatus": "A String", # Status of the url retrieval.
+      "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.
+        "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.
+          { # The metadata for a single URL retrieval.
+            "retrievedUrl": "A String", # The URL retrieved by the tool.
+            "urlRetrievalStatus": "A String", # The status of the URL retrieval.
           },
         ],
       },
@@ -2494,46 +2787,46 @@ 
Method Details

     "blockReason": "A String", # Output only. The reason why the prompt was blocked.
     "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked.
     "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category.
-      { # Safety rating corresponding to the generated content.
-        "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating.
-        "category": "A String", # Output only. Harm category.
+      { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.
+        "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating.
+        "category": "A String", # Output only. The harm category of this rating.
         "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold.
-        "probability": "A String", # Output only. Harm probability levels in the content.
-        "probabilityScore": 3.14, # Output only. Harm probability score.
-        "severity": "A String", # Output only. Harm severity levels in the content.
-        "severityScore": 3.14, # Output only. Harm severity score.
+        "probability": "A String", # Output only. The probability of harm for this category.
+        "probabilityScore": 3.14, # Output only. The probability score of harm for this category.
+        "severity": "A String", # Output only. The severity of harm for this category.
+        "severityScore": 3.14, # Output only. The severity score of harm for this category.
       },
     ],
   },
   "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id.
   "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s).
     "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request.
     "candidatesTokenCount": 42, # The total number of tokens in the generated candidates.
     "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.
     "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable.
     "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.
     "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.
-      { # Represents token counting info for a single modality.
-        "modality": "A String", # The modality associated with this token count.
-        "tokenCount": 42, # Number of tokens.
+      { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.
+        "modality": "A String", # The modality that this token count applies to.
+        "tokenCount": 42, # The number of tokens counted for this modality.
       },
     ],
     "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
index a9abc2ebbe..20a052d4ad 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.html
@@ -217,6 +217,8 @@ 
Method Details

       "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.
     },
   },
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
   "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
   "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
     "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
@@ -450,6 +452,8 @@ 
Method Details

       "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.
     },
   },
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
   "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
   "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
     "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
@@ -624,6 +628,8 @@ 
Method Details

           "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.
         },
       },
+      "satisfiesPzi": True or False, # Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Output only. Reserved for future use.
       "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
       "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
         "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
@@ -804,6 +810,8 @@ 
Method Details

       "httpEndpoint": "A String", # Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.
     },
   },
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
   "updateTime": "A String", # Output only. Timestamp when this RagCorpus was last updated.
   "vectorDbConfig": { # Config for the Vector DB to use for RAG. # Optional. Immutable. The config for the Vector DBs.
     "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # Authentication config for the chosen Vector DB.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
index c8a88dad28..97f3f59d23 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html
@@ -156,52 +156,66 @@ 
Method Details

               "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example.
                 "events": [ # Optional. The input conversation events for the example.
                   { # A single conversation event.
-                    "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event.
-                      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                    "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event.
+                      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                             "outcome": "A String", # Required. Outcome of the code execution.
                             "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                           },
-                          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                             "code": "A String", # Required. The code to be executed.
                             "language": "A String", # Required. Programming language of the `code`.
                           },
-                          "fileData": { # URI based data. # Optional. URI based data.
-                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                            "fileUri": "A String", # Required. URI.
+                          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                           },
-                          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                             "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                               "a_key": "", # Properties of the object.
                             },
                             "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                             "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                           },
-                          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                             "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                             "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                                "fileData": { # URI based data for function response. # URI based data.
+                                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                  "fileUri": "A String", # Required. URI.
+                                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                },
+                                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                  "data": "A String", # Required. Raw bytes.
+                                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                },
+                              },
+                            ],
                             "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                               "a_key": "", # Properties of the object.
                             },
                           },
-                          "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                            "data": "A String", # Required. Raw bytes.
-                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                            "data": "A String", # Required. The raw bytes of the data.
+                            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                           },
-                          "text": "A String", # Optional. Text part (can be code).
-                          "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                          "text": "A String", # Optional. The text content of the part.
+                          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                           "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                             "endOffset": "A String", # Optional. The end offset of the video.
-                            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                             "startOffset": "A String", # Optional. The start offset of the video.
                           },
                         },
                       ],
-                      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
                     },
                   },
                 ],
@@ -235,6 +249,7 @@ 
Method Details

           ],
         },
       ],
+      "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank.
       "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank.
         "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.
       },
@@ -248,6 +263,7 @@ 
Method Details

           "generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED).
           "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL).
         },
+        "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used.
       },
     },
   },
@@ -263,6 +279,9 @@ 
Method Details

   },
   "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
   "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
+    "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card.
+      "a_key": "", # Properties of the object.
+    },
     "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
     "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
       {
@@ -306,10 +325,21 @@ 
Method Details

     "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.
       "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
       "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
-      "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
+      "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.
       "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
     },
     "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
+    "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint.
+      "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request.
+        "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.
+      },
+      "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application.
+        "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.
+        "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent".
+        "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt".
+        "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.
+      },
+    },
   },
   "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
 }
@@ -403,52 +433,66 @@ 
Method Details

               "conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example.
                 "events": [ # Optional. The input conversation events for the example.
                   { # A single conversation event.
-                    "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event.
-                      "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                        { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                    "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event.
+                      "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                        { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                          "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                             "outcome": "A String", # Required. Outcome of the code execution.
                             "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                           },
-                          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                          "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                             "code": "A String", # Required. The code to be executed.
                             "language": "A String", # Required. Programming language of the `code`.
                           },
-                          "fileData": { # URI based data. # Optional. URI based data.
-                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                            "fileUri": "A String", # Required. URI.
+                          "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                            "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                            "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                           },
-                          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                          "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                             "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                               "a_key": "", # Properties of the object.
                             },
                             "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                             "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                           },
-                          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                          "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                             "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                             "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                            "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                              { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                                "fileData": { # URI based data for function response. # URI based data.
+                                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                  "fileUri": "A String", # Required. URI.
+                                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                },
+                                "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                  "data": "A String", # Required. Raw bytes.
+                                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                                },
+                              },
+                            ],
                             "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                               "a_key": "", # Properties of the object.
                             },
                           },
-                          "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                            "data": "A String", # Required. Raw bytes.
-                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                            "data": "A String", # Required. The raw bytes of the data.
+                            "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                             "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                           },
-                          "text": "A String", # Optional. Text part (can be code).
-                          "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                          "text": "A String", # Optional. The text content of the part.
+                          "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                           "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                          "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                          "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                             "endOffset": "A String", # Optional. The end offset of the video.
-                            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                            "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                             "startOffset": "A String", # Optional. The start offset of the video.
                           },
                         },
                       ],
-                      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                      "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
                     },
                   },
                 ],
@@ -482,6 +526,7 @@ 
Method Details

           ],
         },
       ],
+      "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank.
       "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank.
         "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`.
       },
@@ -495,6 +540,7 @@ 
Method Details

           "generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED).
           "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL).
         },
+        "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used.
       },
     },
   },
@@ -510,6 +556,9 @@ 
Method Details

   },
   "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
   "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine
+    "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card.
+      "a_key": "", # Properties of the object.
+    },
     "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
     "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format.
       {
@@ -553,10 +602,21 @@ 
Method Details

     "packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified.
       "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format.
       "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object.
-      "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.
+      "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.
       "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file
     },
     "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.
+    "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint.
+      "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request.
+        "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.
+      },
+      "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application.
+        "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.
+        "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent".
+        "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt".
+        "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.
+      },
+    },
   },
   "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated.
 }
@@ -592,52 +652,66 @@

Method Details

"conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. "events": [ # Optional. The input conversation events for the example. { # A single conversation event. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -671,6 +745,7 @@

Method Details

], }, ], + "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, @@ -684,6 +759,7 @@

Method Details

"generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL). }, + "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used. }, }, }, @@ -699,6 +775,9 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine + "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. + "a_key": "", # Properties of the object. + }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { @@ -742,10 +821,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. }, @@ -786,52 +876,66 @@

Method Details

"conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. "events": [ # Optional. The input conversation events for the example. { # A single conversation event. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -865,6 +969,7 @@

Method Details

], }, ], + "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, @@ -878,6 +983,7 @@

Method Details

"generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL). }, + "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used. }, }, }, @@ -893,6 +999,9 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine + "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. + "a_key": "", # Properties of the object. + }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { @@ -936,10 +1045,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index 5d59d15598..4db84664b8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -79,6 +79,11 @@

Instance Methods

Returns the operations Resource.

+

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

@@ -106,6 +111,9 @@

Instance Methods

retrieve(parent, body=None, x__xgafv=None)

Retrieve memories.

+

+ rollback(name, body=None, x__xgafv=None)

+

Rollback Memory to a specific revision.

Method Details

close() @@ -124,13 +132,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } @@ -212,52 +232,66 @@

Method Details

"directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories. "events": [ # Required. The source content (i.e. chat history) to generate memories from. { # A single piece of conversation from which to generate memories. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. A single piece of content from which to generate memories. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -266,10 +300,22 @@

Method Details

"directMemories": [ # Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request. { # A direct memory to upload to Memory Bank. "fact": "A String", # Required. The fact to consolidate with existing memories. + "topics": [ # Optional. The topics that the consolidated memories should be associated with. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, "disableConsolidation": True or False, # Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled. + "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. + "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, @@ -326,13 +372,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } @@ -361,13 +419,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. }, @@ -402,13 +472,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } @@ -453,6 +535,7 @@

Method Details

The object takes the form of: { # Request message for MemoryBankService.RetrieveMemories. + "filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive. "a_key": "A String", }, @@ -482,13 +565,25 @@

Method Details

"memory": { # A memory. # The retrieved Memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. }, @@ -497,4 +592,46 @@

Method Details

}
+
+ rollback(name, body=None, x__xgafv=None) + 
Rollback Memory to a specific revision.
+
+Args:
+  name: string, Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RollbackMemory.
+  "targetRevisionId": "A String", # Required. The ID of the revision to rollback to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html new file mode 100644 index 0000000000..9cf200f7aa --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.revisions.html @@ -0,0 +1,177 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . memories . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory Revision.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List Memory Revisions for a Memory.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Get a Memory Revision.
+
+Args:
+  name: string, Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a Memory.
+  "createTime": "A String", # Output only. Timestamp when this Memory Revision was created.
+  "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired.
+  "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+    { # An extracted memory that is the intermediate result before consolidation.
+      "fact": "A String", # Output only. The fact of the extracted memory.
+    },
+  ],
+  "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+  "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + 
List Memory Revisions for a Memory.
+
+Args:
+  parent: string, Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemoryRevisions.
+  "memoryRevisions": [ # The list of Memory Revisions in the request page.
+    { # A revision of a Memory.
+      "createTime": "A String", # Output only. Timestamp when this Memory Revision was created.
+      "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired.
+      "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+        { # An extracted memory that is the intermediate result before consolidation.
+          "fact": "A String", # Output only. The fact of the extracted memory.
+        },
+      ],
+      "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+      "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index 3420b379d0..f75ccf964d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Events in a given session.

list_next()

@@ -90,12 +90,13 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) 
Lists Events in a given session.
 
 Args:
   parent: string, Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
   filter: string, Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.
   pageSize: integer, Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.
   pageToken: string, Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.
   x__xgafv: string, V1 error format.
@@ -123,55 +124,68 @@ 
Method Details

           "a_key": "", # Properties of the object.
         },
         "transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
-        "transferToAgent": True or False, # Deprecated. If set, the event transfers to the specified agent.
       },
       "author": "A String", # Required. The name of the agent that sent the event, or user.
-      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Content of the event provided by the author.
-        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
               "outcome": "A String", # Required. Outcome of the code execution.
               "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
             },
-            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
               "code": "A String", # Required. The code to be executed.
               "language": "A String", # Required. Programming language of the `code`.
             },
-            "fileData": { # URI based data. # Optional. URI based data.
-              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-              "fileUri": "A String", # Required. URI.
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
               "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                 "a_key": "", # Properties of the object.
               },
               "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
               "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
             },
-            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
               "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
               "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
               "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                 "a_key": "", # Properties of the object.
               },
             },
-            "inlineData": { # Content blob. # Optional. Inlined bytes data.
-              "data": "A String", # Required. Raw bytes.
-              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "text": "A String", # Optional. Text part (can be code).
-            "thought": True or False, # Optional. Indicates if the part is thought from the model.
+            "text": "A String", # Optional. The text content of the part.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
             "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
               "endOffset": "A String", # Optional. The end offset of the video.
-              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
               "startOffset": "A String", # Optional. The start offset of the video.
             },
           },
         ],
-        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
       },
       "errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
       "errorMessage": "A String", # Optional. Error message if the response is an error.
@@ -180,78 +194,78 @@ 
Method Details

         "customMetadata": { # The custom metadata of the LlmResponse.
           "a_key": "", # Properties of the object.
         },
-        "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Optional. Metadata returned to client when grounding is enabled.
-          "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-          "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-            { # Grounding chunk.
-              "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-                "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                    { # Encapsulates a review snippet.
+        "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Optional. Metadata returned to client when grounding is enabled.
+          "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+          "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+            { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+              "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+                "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                  "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                    { # A review snippet that is used to generate the answer.
                       "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                      "reviewId": "A String", # Id of the review referencing the place.
-                      "title": "A String", # Title of the review.
+                      "reviewId": "A String", # The ID of the review that is being referenced.
+                      "title": "A String", # The title of the review.
                     },
                   ],
                 },
-                "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-                "text": "A String", # Text of the place answer.
-                "title": "A String", # Title of the place.
-                "uri": "A String", # URI reference of the place.
+                "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+                "text": "A String", # The text of the place answer.
+                "title": "A String", # The title of the place.
+                "uri": "A String", # The URI of the place.
               },
-              "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-                "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-                "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+              "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+                "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+                "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
                   "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                     "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                     "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                   },
                   "text": "A String", # The content of the chunk.
                 },
-                "text": "A String", # Text of the attribution.
-                "title": "A String", # Title of the attribution.
-                "uri": "A String", # URI reference of the attribution.
+                "text": "A String", # The content of the retrieved data source.
+                "title": "A String", # The title of the retrieved data source.
+                "uri": "A String", # The URI of the retrieved data source.
               },
-              "web": { # Chunk from the web. # Grounding chunk from the web.
-                "domain": "A String", # Domain of the (original) URI.
-                "title": "A String", # Title of the chunk.
-                "uri": "A String", # URI reference of the chunk.
+              "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+                "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+                "title": "A String", # The title of the web page that contains the evidence.
+                "uri": "A String", # The URI of the web page that contains the evidence.
               },
             },
           ],
-          "groundingSupports": [ # Optional. List of grounding support.
-            { # Grounding support.
-              "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+          "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+            { # A collection of supporting references for a segment of the model's response.
+              "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
                 3.14,
               ],
-              "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+              "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
                 42,
               ],
-              "segment": { # Segment of the content. # Segment of the content this support belongs to.
-                "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-                "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-                "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-                "text": "A String", # Output only. The text corresponding to the segment from the response.
+              "segment": { # A segment of the content. # The content segment that this support message applies to.
+                "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+                "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+                "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+                "text": "A String", # Output only. The text of the segment.
               },
             },
           ],
-          "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-            "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+          "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+            "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
           },
-          "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+          "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
             "A String",
           ],
-          "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-            "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-            "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+          "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+            "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+            "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
           },
-          "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-            { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-              "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-              "sourceId": "A String", # Id of the place or review.
+          "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+            { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+              "flagContentUri": "A String", # The URI that can be used to flag the content.
+              "sourceId": "A String", # The ID of the place or review.
             },
           ],
-          "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+          "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
             "A String",
           ],
         },
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
index 2436e2d6b7..a3d2df8788 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html
@@ -132,55 +132,68 @@ 
Method Details

       "a_key": "", # Properties of the object.
     },
     "transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
-    "transferToAgent": True or False, # Deprecated. If set, the event transfers to the specified agent.
   },
   "author": "A String", # Required. The name of the agent that sent the event, or user.
-  "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Content of the event provided by the author.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
   "errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
   "errorMessage": "A String", # Optional. Error message if the response is an error.
@@ -189,78 +202,78 @@ 
Method Details

     "customMetadata": { # The custom metadata of the LlmResponse.
       "a_key": "", # Properties of the object.
     },
-    "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Optional. Metadata returned to client when grounding is enabled.
-      "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-      "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-        { # Grounding chunk.
-          "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-            "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-              "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                { # Encapsulates a review snippet.
+    "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Optional. Metadata returned to client when grounding is enabled.
+      "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+      "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+        { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+          "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+            "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+              "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                { # A review snippet that is used to generate the answer.
                   "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                  "reviewId": "A String", # Id of the review referencing the place.
-                  "title": "A String", # Title of the review.
+                  "reviewId": "A String", # The ID of the review that is being referenced.
+                  "title": "A String", # The title of the review.
                 },
               ],
             },
-            "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-            "text": "A String", # Text of the place answer.
-            "title": "A String", # Title of the place.
-            "uri": "A String", # URI reference of the place.
+            "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+            "text": "A String", # The text of the place answer.
+            "title": "A String", # The title of the place.
+            "uri": "A String", # The URI of the place.
           },
-          "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-            "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-            "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+          "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+            "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+            "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
               "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                 "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                 "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
               },
               "text": "A String", # The content of the chunk.
             },
-            "text": "A String", # Text of the attribution.
-            "title": "A String", # Title of the attribution.
-            "uri": "A String", # URI reference of the attribution.
+            "text": "A String", # The content of the retrieved data source.
+            "title": "A String", # The title of the retrieved data source.
+            "uri": "A String", # The URI of the retrieved data source.
           },
-          "web": { # Chunk from the web. # Grounding chunk from the web.
-            "domain": "A String", # Domain of the (original) URI.
-            "title": "A String", # Title of the chunk.
-            "uri": "A String", # URI reference of the chunk.
+          "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+            "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+            "title": "A String", # The title of the web page that contains the evidence.
+            "uri": "A String", # The URI of the web page that contains the evidence.
           },
         },
       ],
-      "groundingSupports": [ # Optional. List of grounding support.
-        { # Grounding support.
-          "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+      "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+        { # A collection of supporting references for a segment of the model's response.
+          "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
             3.14,
           ],
-          "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+          "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
             42,
           ],
-          "segment": { # Segment of the content. # Segment of the content this support belongs to.
-            "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-            "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-            "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-            "text": "A String", # Output only. The text corresponding to the segment from the response.
+          "segment": { # A segment of the content. # The content segment that this support message applies to.
+            "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+            "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+            "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+            "text": "A String", # Output only. The text of the segment.
           },
         },
       ],
-      "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-        "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+      "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+        "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
       },
-      "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+      "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
         "A String",
       ],
-      "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-        "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-        "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+      "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+        "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+        "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
       },
-      "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-        { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-          "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-          "sourceId": "A String", # Id of the place or review.
+      "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+        { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+          "flagContentUri": "A String", # The URI that can be used to flag the content.
+          "sourceId": "A String", # The ID of the place or review.
         },
       ],
-      "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+      "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
         "A String",
       ],
     },
@@ -413,7 +426,7 @@ 
Method Details

 
 Args:
   parent: string, Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
-  filter: string, Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.
+  filter: string, Optional. The standard list filter. Supported fields: * `display_name` * `user_id` Example: `display_name="abc"`, `user_id="123"`.
   orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
   pageSize: integer, Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.
   pageToken: string, Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
index 9371b782ef..b603797bc6 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html
@@ -193,6 +193,9 @@ 
Method Details

               "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric.
                 "score": 3.14, # Output only. Bleu score.
               },
+              "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric.
+                "score": 3.14, # Output only. Custom code execution score.
+              },
               "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric.
                 "score": 3.14, # Output only. Exact match score.
               },
@@ -272,32 +275,53 @@ 
Method Details

     "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
   },
   "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
-    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
+    "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
+      "adapterSize": "A String", # Optional. Adapter size for preference optimization.
+      "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+      "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+    },
+    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+  },
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
+  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+  "state": "A String", # Output only. The detailed state of the job.
+  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
       "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
         "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
         "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-        "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-          "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-          "candidateCount": 42, # Optional. Number of candidates to generate.
-          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-          "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-          "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+        "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+          "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+          "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+          "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+          "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
             "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+            "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+              "compressionQuality": 42, # Optional. The compression quality of the output image.
+              "mimeType": "A String", # Optional. The image format that the output should be saved as.
+            },
+            "personGeneration": "A String", # Optional. Controls whether the model can generate people.
           },
-          "logprobs": 42, # Optional. Logit probabilities.
-          "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-          "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+          "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+          "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+          "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
           "modelConfig": { # Config for model selection. # Optional. Config for model selection.
             "featureSelectionPreference": "A String", # Required. Feature selection preference.
           },
-          "presencePenalty": 3.14, # Optional. Positive penalties.
-          "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-          "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-          "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-          "responseModalities": [ # Optional. The modalities of the response.
+          "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+          "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+          "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+          "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+          "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
             "A String",
           ],
-          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
             "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
             "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
               # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -336,45 +360,45 @@ 
Method Details

             "title": "A String", # Optional. The title of the Schema.
             "type": "A String", # Optional. The type of the data.
           },
-          "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-            "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+          "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+            "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
               "modelRoutingPreference": "A String", # The model routing preference.
             },
-            "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-              "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+            "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+              "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
             },
           },
-          "seed": 42, # Optional. Seed.
-          "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-            "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+          "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+          "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+            "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
               "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                { # Configuration for a single speaker in a multi speaker setup.
+                { # Configuration for a single speaker in a multi-speaker setup.
                   "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                  "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
+                  "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
                     },
                   },
                 },
               ],
             },
-            "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
-          "stopSequences": [ # Optional. Stop sequences.
+          "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
             "A String",
           ],
-          "temperature": 3.14, # Optional. Controls the randomness of predictions.
-          "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-            "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-            "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+          "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+          "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+            "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+            "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
           },
-          "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-          "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+          "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+          "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
         },
         "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
       },
@@ -386,6 +410,9 @@ 
Method Details

           "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
             "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
           },
+          "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+            "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```
+          },
           "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
           },
           "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
@@ -395,28 +422,33 @@ 
Method Details

             "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
               "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
               "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                "candidateCount": 42, # Optional. Number of candidates to generate.
-                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                   "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                 },
-                "logprobs": 42, # Optional. Logit probabilities.
-                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                 "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                   "featureSelectionPreference": "A String", # Required. Feature selection preference.
                 },
-                "presencePenalty": 3.14, # Optional. Positive penalties.
-                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                "responseModalities": [ # Optional. The modalities of the response.
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                   "A String",
                 ],
-                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                   "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                   "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                     # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -455,45 +487,45 @@ 
Method Details

                   "title": "A String", # Optional. The title of the Schema.
                   "type": "A String", # Optional. The type of the data.
                 },
-                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                     "modelRoutingPreference": "A String", # The model routing preference.
                   },
-                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                   },
                 },
-                "seed": 42, # Optional. Seed.
-                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                     "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                      { # Configuration for a single speaker in a multi speaker setup.
+                      { # Configuration for a single speaker in a multi-speaker setup.
                         "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                        "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
                           },
                         },
                       },
                     ],
                   },
-                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
                     },
                   },
                 },
-                "stopSequences": [ # Optional. Stop sequences.
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                   "A String",
                 ],
-                "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                 },
-                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
               },
               "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
             },
@@ -508,28 +540,33 @@ 
Method Details

               "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
                 "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
                 "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                  "candidateCount": 42, # Optional. Number of candidates to generate.
-                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                  "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+                "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                  "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                  "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                  "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                     "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                    "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                      "compressionQuality": 42, # Optional. The compression quality of the output image.
+                      "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                    },
+                    "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                   },
-                  "logprobs": 42, # Optional. Logit probabilities.
-                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                  "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                  "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                  "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                   "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                     "featureSelectionPreference": "A String", # Required. Feature selection preference.
                   },
-                  "presencePenalty": 3.14, # Optional. Positive penalties.
-                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                  "responseModalities": [ # Optional. The modalities of the response.
+                  "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                  "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                  "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                  "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                  "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                     "A String",
                   ],
-                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                     "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                     "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                       # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -568,45 +605,45 @@ 
Method Details

                     "title": "A String", # Optional. The title of the Schema.
                     "type": "A String", # Optional. The type of the data.
                   },
-                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                    "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                       "modelRoutingPreference": "A String", # The model routing preference.
                     },
-                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                      "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                     },
                   },
-                  "seed": 42, # Optional. Seed.
-                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                  "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                       "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                        { # Configuration for a single speaker in a multi speaker setup.
+                        { # Configuration for a single speaker in a multi-speaker setup.
                           "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                          "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                              "voiceName": "A String", # The name of the preset voice to use.
+                          "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                            "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                              "voiceName": "A String", # The name of the prebuilt voice to use.
                             },
                           },
                         },
                       ],
                     },
-                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                        "voiceName": "A String", # The name of the preset voice to use.
+                    "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
                       },
                     },
                   },
-                  "stopSequences": [ # Optional. Stop sequences.
+                  "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                     "A String",
                   ],
-                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                  "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                  "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                   },
-                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                  "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                  "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
                 },
                 "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
               },
@@ -654,497 +691,113 @@ 
Method Details

         },
       },
     },
-    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
-    "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
-      "adapterSize": "A String", # Optional. Adapter size for preference optimization.
-      "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
+    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+      "adapterSize": "A String", # Optional. Adapter size for tuning.
+      "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
       "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+      "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
     },
-    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
-    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+    "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+    "tuningMode": "A String", # Tuning mode.
+    "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
   },
-  "satisfiesPzi": True or False, # Output only. Reserved for future use.
-  "satisfiesPzs": True or False, # Output only. Reserved for future use.
-  "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
-  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
-  "state": "A String", # Output only. The detailed state of the job.
-  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
-    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
-      "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
-        "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-        "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-        "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-          "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-          "candidateCount": 42, # Optional. Number of candidates to generate.
-          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-          "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-          "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-            "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-          },
-          "logprobs": 42, # Optional. Logit probabilities.
-          "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-          "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-          "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-            "featureSelectionPreference": "A String", # Required. Feature selection preference.
-          },
-          "presencePenalty": 3.14, # Optional. Positive penalties.
-          "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-          "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-          "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-          "responseModalities": [ # Optional. The modalities of the response.
-            "A String",
-          ],
-          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            ],
-            "default": "", # Optional. Default value of the data.
-            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            },
-            "description": "A String", # Optional. The description of the data.
-            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-              "A String",
-            ],
-            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-            "nullable": True or False, # Optional. Indicates if the value may be null.
-            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            },
-            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-              "A String",
-            ],
-            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-            "required": [ # Optional. Required properties of Type.OBJECT.
-              "A String",
-            ],
-            "title": "A String", # Optional. The title of the Schema.
-            "type": "A String", # Optional. The type of the data.
-          },
-          "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-            "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-              "modelRoutingPreference": "A String", # The model routing preference.
-            },
-            "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-              "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-            },
-          },
-          "seed": 42, # Optional. Seed.
-          "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-            "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-              "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                { # Configuration for a single speaker in a multi speaker setup.
-                  "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                  "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
-                    },
-                  },
-                },
-              ],
-            },
-            "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
-              },
-            },
-          },
-          "stopSequences": [ # Optional. Stop sequences.
-            "A String",
-          ],
-          "temperature": 3.14, # Optional. Controls the randomness of predictions.
-          "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-            "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-            "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-          },
-          "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-          "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-        },
-        "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
+    "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
+      { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
+        "checkpointId": "A String", # The ID of the checkpoint.
+        "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+        "epoch": "A String", # The epoch of the checkpoint.
+        "step": "A String", # The step of the checkpoint.
       },
-      "metrics": [ # Required. The metrics used for evaluation.
-        { # The metric used for running evaluations.
-          "aggregationMetrics": [ # Optional. The aggregation metrics to use.
-            "A String",
-          ],
-          "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
-            "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
-          },
-          "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
-          },
-          "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
-            "additionalConfig": { # Optional. Optional additional configuration for the metric.
-              "a_key": "", # Properties of the object.
-            },
-            "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
-              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                "candidateCount": 42, # Optional. Number of candidates to generate.
-                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+    ],
+    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+  },
+  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
+  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+    "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
+      "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+        "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+          "A String",
+        ],
+        "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+          "A String",
+        ],
+        "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+        "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+        "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+        "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+        "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+          { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+            "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+              { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                 },
-                "logprobs": 42, # Optional. Logit probabilities.
-                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                  "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
                 },
-                "presencePenalty": 3.14, # Optional. Positive penalties.
-                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                "responseModalities": [ # Optional. The modalities of the response.
-                  "A String",
-                ],
-                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  ],
-                  "default": "", # Optional. Default value of the data.
-                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  },
-                  "description": "A String", # Optional. The description of the data.
-                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                    "A String",
-                  ],
-                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                  "nullable": True or False, # Optional. Indicates if the value may be null.
-                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  },
-                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                    "A String",
-                  ],
-                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                  "required": [ # Optional. Required properties of Type.OBJECT.
-                    "A String",
-                  ],
-                  "title": "A String", # Optional. The title of the Schema.
-                  "type": "A String", # Optional. The type of the data.
+                "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                  "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                  "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                 },
-                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                    "modelRoutingPreference": "A String", # The model routing preference.
-                  },
-                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                  "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                    "a_key": "", # Properties of the object.
                   },
+                  "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                  "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                 },
-                "seed": 42, # Optional. Seed.
-                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                      { # Configuration for a single speaker in a multi speaker setup.
-                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                        "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
-                          },
-                        },
+                "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                  "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                    { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                      "fileData": { # URI based data for function response. # URI based data.
+                        "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "fileUri": "A String", # Required. URI.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                        "data": "A String", # Required. Raw bytes.
+                        "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                       },
-                    ],
-                  },
-                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
                     },
+                  ],
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
                   },
                 },
-                "stopSequences": [ # Optional. Stop sequences.
-                  "A String",
-                ],
-                "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                  "data": "A String", # Required. The raw bytes of the data.
+                  "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. The text content of the part.
+                "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
                 },
-                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-              },
-              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
-            },
-            "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
-            "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
-              "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-              "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-                "a_key": "", # Properties of the object.
               },
-            },
-            "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
-              "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
-                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-                "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                  "candidateCount": 42, # Optional. Number of candidates to generate.
-                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                  "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                    "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-                  },
-                  "logprobs": 42, # Optional. Logit probabilities.
-                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                  "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                    "featureSelectionPreference": "A String", # Required. Feature selection preference.
-                  },
-                  "presencePenalty": 3.14, # Optional. Positive penalties.
-                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                  "responseModalities": [ # Optional. The modalities of the response.
-                    "A String",
-                  ],
-                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                    "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                    "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                      # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    ],
-                    "default": "", # Optional. Default value of the data.
-                    "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    },
-                    "description": "A String", # Optional. The description of the data.
-                    "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                      "A String",
-                    ],
-                    "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                    "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                    "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                    "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                    "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                    "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                    "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                    "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                    "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                    "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                    "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                    "nullable": True or False, # Optional. Indicates if the value may be null.
-                    "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                    "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    },
-                    "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                      "A String",
-                    ],
-                    "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                    "required": [ # Optional. Required properties of Type.OBJECT.
-                      "A String",
-                    ],
-                    "title": "A String", # Optional. The title of the Schema.
-                    "type": "A String", # Optional. The type of the data.
-                  },
-                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                      "modelRoutingPreference": "A String", # The model routing preference.
-                    },
-                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-                    },
-                  },
-                  "seed": 42, # Optional. Seed.
-                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                      "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                        { # Configuration for a single speaker in a multi speaker setup.
-                          "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                          "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                              "voiceName": "A String", # The name of the preset voice to use.
-                            },
-                          },
-                        },
-                      ],
-                    },
-                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                        "voiceName": "A String", # The name of the preset voice to use.
-                      },
-                    },
-                  },
-                  "stopSequences": [ # Optional. Stop sequences.
-                    "A String",
-                  ],
-                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-                  },
-                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-                },
-                "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
-              },
-              "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
-              "rubricContentType": "A String", # The type of rubric content to be generated.
-              "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
-                "A String",
-              ],
-            },
-            "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
-            "systemInstruction": "A String", # Optional. System instructions for the judge model.
-          },
-          "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
-            "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
-            "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
-            "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
-              "returnRawOutput": True or False, # Optional. Whether to return raw output.
-            },
-            "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
-            "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
-          },
-          "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
-            "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
-              "returnRawOutput": True or False, # Optional. Whether to return raw output.
-            },
-            "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
-            "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
-          },
-          "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
-            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-              "a_key": "", # Properties of the object.
-            },
-          },
-          "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
-            "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
-            "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
-            "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
-          },
-        },
-      ],
-      "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
-        "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
-          "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
-        },
-      },
-    },
-    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
-    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
-      "adapterSize": "A String", # Optional. Adapter size for tuning.
-      "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
-      "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-      "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
-      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
-    },
-    "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-    "tuningMode": "A String", # Tuning mode.
-    "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-  },
-  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
-    "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
-      { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
-        "checkpointId": "A String", # The ID of the checkpoint.
-        "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-        "epoch": "A String", # The epoch of the checkpoint.
-        "step": "A String", # The step of the checkpoint.
-      },
-    ],
-    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
-  },
-  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
-  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
-    "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
-      "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
-        "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
-          "A String",
-        ],
-        "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
-          "A String",
-        ],
-        "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
-        "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
-        "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
-        "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
-        "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-          { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
-                  "outcome": "A String", # Required. Outcome of the code execution.
-                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
-                },
-                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
-                  "code": "A String", # Required. The code to be executed.
-                  "language": "A String", # Required. Programming language of the `code`.
-                },
-                "fileData": { # URI based data. # Optional. URI based data.
-                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "fileUri": "A String", # Required. URI.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
-                  "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
-                    "a_key": "", # Properties of the object.
-                  },
-                  "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
-                  "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
-                },
-                "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
-                  "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
-                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
-                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
-                    "a_key": "", # Properties of the object.
-                  },
-                },
-                "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                  "data": "A String", # Required. Raw bytes.
-                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "text": "A String", # Optional. Text part (can be code).
-                "thought": True or False, # Optional. Indicates if the part is thought from the model.
-                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
-                  "endOffset": "A String", # Optional. The end offset of the video.
-                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
-                  "startOffset": "A String", # Optional. The start offset of the video.
-                },
-              },
-            ],
-            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-          },
-        ],
-        "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
-          "buckets": [ # Output only. Defines the histogram bucket.
-            { # Dataset bucket used to create a histogram for the distribution given a population of values.
-              "count": "A String", # Output only. Number of values in the bucket.
-              "left": 3.14, # Output only. Left bound of the bucket.
-              "right": 3.14, # Output only. Right bound of the bucket.
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+          },
+        ],
+        "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
+          "buckets": [ # Output only. Defines the histogram bucket.
+            { # Dataset bucket used to create a histogram for the distribution given a population of values.
+              "count": "A String", # Output only. Number of values in the bucket.
+              "left": 3.14, # Output only. Left bound of the bucket.
+              "right": 3.14, # Output only. Right bound of the bucket.
             },
           ],
           "max": 3.14, # Output only. The maximum of the population values.
@@ -1235,103 +888,131 @@ 
Method Details

         { # Input example for preference optimization.
           "completions": [ # List of completions for a given prompt.
             { # Completion and its preference score.
-              "completion": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Single turn completion for the given prompt.
-                "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                  { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+              "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt.
+                "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                  { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                       "outcome": "A String", # Required. Outcome of the code execution.
                       "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                     },
-                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                       "code": "A String", # Required. The code to be executed.
                       "language": "A String", # Required. Programming language of the `code`.
                     },
-                    "fileData": { # URI based data. # Optional. URI based data.
-                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                      "fileUri": "A String", # Required. URI.
+                    "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                      "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                       "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                       "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                         "a_key": "", # Properties of the object.
                       },
                       "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                       "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                     },
-                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                       "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                       "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                      "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                        { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                          "fileData": { # URI based data for function response. # URI based data.
+                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "fileUri": "A String", # Required. URI.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                          "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                            "data": "A String", # Required. Raw bytes.
+                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                        },
+                      ],
                       "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                         "a_key": "", # Properties of the object.
                       },
                     },
-                    "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                      "data": "A String", # Required. Raw bytes.
-                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                      "data": "A String", # Required. The raw bytes of the data.
+                      "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                       "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "text": "A String", # Optional. Text part (can be code).
-                    "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                    "text": "A String", # Optional. The text content of the part.
+                    "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                     "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                    "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                       "endOffset": "A String", # Optional. The end offset of the video.
-                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                       "startOffset": "A String", # Optional. The start offset of the video.
                     },
                   },
                 ],
-                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
               },
               "score": 3.14, # The score for the given completion.
             },
           ],
           "contents": [ # Multi-turn contents that represents the Prompt.
-            { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+            { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+              "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                     "outcome": "A String", # Required. Outcome of the code execution.
                     "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                   },
-                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                     "code": "A String", # Required. The code to be executed.
                     "language": "A String", # Required. Programming language of the `code`.
                   },
-                  "fileData": { # URI based data. # Optional. URI based data.
-                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                    "fileUri": "A String", # Required. URI.
+                  "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                    "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                    "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                     "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                       "a_key": "", # Properties of the object.
                     },
                     "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                     "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                   },
-                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                     "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                     "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                      { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                        "fileData": { # URI based data for function response. # URI based data.
+                          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "fileUri": "A String", # Required. URI.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                        "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                          "data": "A String", # Required. Raw bytes.
+                          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                      },
+                    ],
                     "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                       "a_key": "", # Properties of the object.
                     },
                   },
-                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                    "data": "A String", # Required. Raw bytes.
-                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                    "data": "A String", # Required. The raw bytes of the data.
+                    "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "text": "A String", # Optional. Text part (can be code).
-                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "text": "A String", # Optional. The text content of the part.
+                  "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                   "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                     "endOffset": "A String", # Optional. The end offset of the video.
-                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                     "startOffset": "A String", # Optional. The start offset of the video.
                   },
                 },
               ],
-              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
             },
           ],
         },
@@ -1383,52 +1064,66 @@ 
Method Details

       "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
       "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
       "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-        { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-          "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-              "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+        { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                 "outcome": "A String", # Required. Outcome of the code execution.
                 "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
               },
-              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                 "code": "A String", # Required. The code to be executed.
                 "language": "A String", # Required. Programming language of the `code`.
               },
-              "fileData": { # URI based data. # Optional. URI based data.
-                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                "fileUri": "A String", # Required. URI.
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                 "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
               },
-              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                 "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                   "a_key": "", # Properties of the object.
                 },
                 "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                 "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
               },
-              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                 "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                 "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
                 "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                   "a_key": "", # Properties of the object.
                 },
               },
-              "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                "data": "A String", # Required. Raw bytes.
-                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                 "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
               },
-              "text": "A String", # Optional. Text part (can be code).
-              "thought": True or False, # Optional. Indicates if the part is thought from the model.
+              "text": "A String", # Optional. The text content of the part.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
               "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-              "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                 "endOffset": "A String", # Optional. The end offset of the video.
-                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                 "startOffset": "A String", # Optional. The start offset of the video.
               },
             },
           ],
-          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
         },
       ],
       "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
@@ -1556,6 +1251,9 @@ 
Method Details

               "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric.
                 "score": 3.14, # Output only. Bleu score.
               },
+              "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric.
+                "score": 3.14, # Output only. Custom code execution score.
+              },
               "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric.
                 "score": 3.14, # Output only. Exact match score.
               },
@@ -1635,32 +1333,53 @@ 
Method Details

     "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
   },
   "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
-    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
+    "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
+      "adapterSize": "A String", # Optional. Adapter size for preference optimization.
+      "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+      "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+    },
+    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+  },
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
+  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+  "state": "A String", # Output only. The detailed state of the job.
+  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
       "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
         "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
         "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-        "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-          "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-          "candidateCount": 42, # Optional. Number of candidates to generate.
-          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-          "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-          "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+        "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+          "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+          "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+          "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+          "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
             "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+            "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+              "compressionQuality": 42, # Optional. The compression quality of the output image.
+              "mimeType": "A String", # Optional. The image format that the output should be saved as.
+            },
+            "personGeneration": "A String", # Optional. Controls whether the model can generate people.
           },
-          "logprobs": 42, # Optional. Logit probabilities.
-          "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-          "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+          "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+          "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+          "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
           "modelConfig": { # Config for model selection. # Optional. Config for model selection.
             "featureSelectionPreference": "A String", # Required. Feature selection preference.
           },
-          "presencePenalty": 3.14, # Optional. Positive penalties.
-          "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-          "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-          "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-          "responseModalities": [ # Optional. The modalities of the response.
+          "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+          "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+          "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+          "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+          "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
             "A String",
           ],
-          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
             "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
             "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
               # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1699,45 +1418,45 @@ 
Method Details

             "title": "A String", # Optional. The title of the Schema.
             "type": "A String", # Optional. The type of the data.
           },
-          "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-            "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+          "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+            "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
               "modelRoutingPreference": "A String", # The model routing preference.
             },
-            "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-              "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+            "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+              "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
             },
           },
-          "seed": 42, # Optional. Seed.
-          "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-            "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+          "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+          "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+            "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
               "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                { # Configuration for a single speaker in a multi speaker setup.
+                { # Configuration for a single speaker in a multi-speaker setup.
                   "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                  "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
+                  "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
                     },
                   },
                 },
               ],
             },
-            "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
-          "stopSequences": [ # Optional. Stop sequences.
+          "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
             "A String",
           ],
-          "temperature": 3.14, # Optional. Controls the randomness of predictions.
-          "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-            "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-            "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+          "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+          "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+            "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+            "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
           },
-          "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-          "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+          "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+          "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
         },
         "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
       },
@@ -1749,6 +1468,9 @@ 
Method Details

           "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
             "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
           },
+          "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+            "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```
+          },
           "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
           },
           "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
@@ -1758,28 +1480,33 @@ 
Method Details

             "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
               "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
               "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                "candidateCount": 42, # Optional. Number of candidates to generate.
-                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                   "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                 },
-                "logprobs": 42, # Optional. Logit probabilities.
-                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                 "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                   "featureSelectionPreference": "A String", # Required. Feature selection preference.
                 },
-                "presencePenalty": 3.14, # Optional. Positive penalties.
-                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                "responseModalities": [ # Optional. The modalities of the response.
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                   "A String",
                 ],
-                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                   "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                   "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                     # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1818,45 +1545,45 @@ 
Method Details

                   "title": "A String", # Optional. The title of the Schema.
                   "type": "A String", # Optional. The type of the data.
                 },
-                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                     "modelRoutingPreference": "A String", # The model routing preference.
                   },
-                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                   },
                 },
-                "seed": 42, # Optional. Seed.
-                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                     "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                      { # Configuration for a single speaker in a multi speaker setup.
+                      { # Configuration for a single speaker in a multi-speaker setup.
                         "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                        "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
                           },
                         },
                       },
                     ],
                   },
-                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
                     },
                   },
                 },
-                "stopSequences": [ # Optional. Stop sequences.
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                   "A String",
                 ],
-                "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                 },
-                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
               },
               "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
             },
@@ -1871,28 +1598,33 @@ 
Method Details

               "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
                 "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
                 "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                  "candidateCount": 42, # Optional. Number of candidates to generate.
-                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                  "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+                "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                  "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                  "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                  "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                     "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                    "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                      "compressionQuality": 42, # Optional. The compression quality of the output image.
+                      "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                    },
+                    "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                   },
-                  "logprobs": 42, # Optional. Logit probabilities.
-                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                  "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                  "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                  "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                   "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                     "featureSelectionPreference": "A String", # Required. Feature selection preference.
                   },
-                  "presencePenalty": 3.14, # Optional. Positive penalties.
-                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                  "responseModalities": [ # Optional. The modalities of the response.
+                  "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                  "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                  "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                  "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                  "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                     "A String",
                   ],
-                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                     "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                     "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                       # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -1931,45 +1663,45 @@ 
Method Details

                     "title": "A String", # Optional. The title of the Schema.
                     "type": "A String", # Optional. The type of the data.
                   },
-                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                    "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                       "modelRoutingPreference": "A String", # The model routing preference.
                     },
-                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                      "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                     },
                   },
-                  "seed": 42, # Optional. Seed.
-                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                  "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                       "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                        { # Configuration for a single speaker in a multi speaker setup.
+                        { # Configuration for a single speaker in a multi-speaker setup.
                           "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                          "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                              "voiceName": "A String", # The name of the preset voice to use.
+                          "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                            "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                              "voiceName": "A String", # The name of the prebuilt voice to use.
                             },
                           },
                         },
                       ],
                     },
-                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                        "voiceName": "A String", # The name of the preset voice to use.
+                    "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
                       },
                     },
                   },
-                  "stopSequences": [ # Optional. Stop sequences.
+                  "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                     "A String",
                   ],
-                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                  "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                  "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                   },
-                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                  "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                  "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
                 },
                 "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
               },
@@ -2017,513 +1749,129 @@ 
Method Details

         },
       },
     },
-    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
-    "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
-      "adapterSize": "A String", # Optional. Adapter size for preference optimization.
-      "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
+    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+      "adapterSize": "A String", # Optional. Adapter size for tuning.
+      "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
       "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+      "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
     },
-    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
-    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+    "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+    "tuningMode": "A String", # Tuning mode.
+    "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
   },
-  "satisfiesPzi": True or False, # Output only. Reserved for future use.
-  "satisfiesPzs": True or False, # Output only. Reserved for future use.
-  "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
-  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
-  "state": "A String", # Output only. The detailed state of the job.
-  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
-    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
-      "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
-        "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-        "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-        "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-          "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-          "candidateCount": 42, # Optional. Number of candidates to generate.
-          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-          "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-          "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-            "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-          },
-          "logprobs": 42, # Optional. Logit probabilities.
-          "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-          "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-          "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-            "featureSelectionPreference": "A String", # Required. Feature selection preference.
-          },
-          "presencePenalty": 3.14, # Optional. Positive penalties.
-          "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-          "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-          "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-          "responseModalities": [ # Optional. The modalities of the response.
-            "A String",
-          ],
-          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            ],
-            "default": "", # Optional. Default value of the data.
-            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            },
-            "description": "A String", # Optional. The description of the data.
-            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-              "A String",
-            ],
-            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-            "nullable": True or False, # Optional. Indicates if the value may be null.
-            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            },
-            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-              "A String",
-            ],
-            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-            "required": [ # Optional. Required properties of Type.OBJECT.
-              "A String",
-            ],
-            "title": "A String", # Optional. The title of the Schema.
-            "type": "A String", # Optional. The type of the data.
-          },
-          "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-            "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-              "modelRoutingPreference": "A String", # The model routing preference.
-            },
-            "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-              "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-            },
-          },
-          "seed": 42, # Optional. Seed.
-          "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-            "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-              "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                { # Configuration for a single speaker in a multi speaker setup.
-                  "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                  "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
-                    },
-                  },
-                },
-              ],
-            },
-            "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
-              },
-            },
-          },
-          "stopSequences": [ # Optional. Stop sequences.
-            "A String",
-          ],
-          "temperature": 3.14, # Optional. Controls the randomness of predictions.
-          "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-            "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-            "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-          },
-          "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-          "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-        },
-        "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
+    "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
+      { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
+        "checkpointId": "A String", # The ID of the checkpoint.
+        "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+        "epoch": "A String", # The epoch of the checkpoint.
+        "step": "A String", # The step of the checkpoint.
       },
-      "metrics": [ # Required. The metrics used for evaluation.
-        { # The metric used for running evaluations.
-          "aggregationMetrics": [ # Optional. The aggregation metrics to use.
-            "A String",
-          ],
-          "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
-            "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
-          },
-          "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
-          },
-          "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
-            "additionalConfig": { # Optional. Optional additional configuration for the metric.
-              "a_key": "", # Properties of the object.
-            },
-            "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
-              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                "candidateCount": 42, # Optional. Number of candidates to generate.
-                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+    ],
+    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+  },
+  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
+  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+    "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
+      "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+        "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+          "A String",
+        ],
+        "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+          "A String",
+        ],
+        "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+        "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+        "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+        "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+        "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+          { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+            "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+              { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                 },
-                "logprobs": 42, # Optional. Logit probabilities.
-                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                  "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
                 },
-                "presencePenalty": 3.14, # Optional. Positive penalties.
-                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                "responseModalities": [ # Optional. The modalities of the response.
-                  "A String",
-                ],
-                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  ],
-                  "default": "", # Optional. Default value of the data.
-                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  },
-                  "description": "A String", # Optional. The description of the data.
-                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                    "A String",
-                  ],
-                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                  "nullable": True or False, # Optional. Indicates if the value may be null.
-                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  },
-                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                    "A String",
-                  ],
-                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                  "required": [ # Optional. Required properties of Type.OBJECT.
-                    "A String",
-                  ],
-                  "title": "A String", # Optional. The title of the Schema.
-                  "type": "A String", # Optional. The type of the data.
+                "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                  "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                  "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                 },
-                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                    "modelRoutingPreference": "A String", # The model routing preference.
-                  },
-                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                  "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                    "a_key": "", # Properties of the object.
                   },
+                  "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                  "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                 },
-                "seed": 42, # Optional. Seed.
-                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                      { # Configuration for a single speaker in a multi speaker setup.
-                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                        "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
-                          },
-                        },
+                "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                  "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                    { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                      "fileData": { # URI based data for function response. # URI based data.
+                        "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "fileUri": "A String", # Required. URI.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                        "data": "A String", # Required. Raw bytes.
+                        "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                       },
-                    ],
-                  },
-                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
                     },
+                  ],
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
                   },
                 },
-                "stopSequences": [ # Optional. Stop sequences.
-                  "A String",
-                ],
-                "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                  "data": "A String", # Required. The raw bytes of the data.
+                  "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. The text content of the part.
+                "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
                 },
-                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
               },
-              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+          },
+        ],
+        "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
+          "buckets": [ # Output only. Defines the histogram bucket.
+            { # Dataset bucket used to create a histogram for the distribution given a population of values.
+              "count": "A String", # Output only. Number of values in the bucket.
+              "left": 3.14, # Output only. Left bound of the bucket.
+              "right": 3.14, # Output only. Right bound of the bucket.
             },
-            "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
-            "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
-              "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-              "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-                "a_key": "", # Properties of the object.
-              },
-            },
-            "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
-              "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
-                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-                "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                  "candidateCount": 42, # Optional. Number of candidates to generate.
-                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                  "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                    "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-                  },
-                  "logprobs": 42, # Optional. Logit probabilities.
-                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                  "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                    "featureSelectionPreference": "A String", # Required. Feature selection preference.
-                  },
-                  "presencePenalty": 3.14, # Optional. Positive penalties.
-                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                  "responseModalities": [ # Optional. The modalities of the response.
-                    "A String",
-                  ],
-                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                    "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                    "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                      # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    ],
-                    "default": "", # Optional. Default value of the data.
-                    "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    },
-                    "description": "A String", # Optional. The description of the data.
-                    "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                      "A String",
-                    ],
-                    "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                    "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                    "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                    "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                    "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                    "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                    "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                    "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                    "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                    "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                    "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                    "nullable": True or False, # Optional. Indicates if the value may be null.
-                    "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                    "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    },
-                    "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                      "A String",
-                    ],
-                    "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                    "required": [ # Optional. Required properties of Type.OBJECT.
-                      "A String",
-                    ],
-                    "title": "A String", # Optional. The title of the Schema.
-                    "type": "A String", # Optional. The type of the data.
-                  },
-                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                      "modelRoutingPreference": "A String", # The model routing preference.
-                    },
-                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-                    },
-                  },
-                  "seed": 42, # Optional. Seed.
-                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                      "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                        { # Configuration for a single speaker in a multi speaker setup.
-                          "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                          "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                              "voiceName": "A String", # The name of the preset voice to use.
-                            },
-                          },
-                        },
-                      ],
-                    },
-                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                        "voiceName": "A String", # The name of the preset voice to use.
-                      },
-                    },
-                  },
-                  "stopSequences": [ # Optional. Stop sequences.
-                    "A String",
-                  ],
-                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-                  },
-                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-                },
-                "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
-              },
-              "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
-              "rubricContentType": "A String", # The type of rubric content to be generated.
-              "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
-                "A String",
-              ],
-            },
-            "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
-            "systemInstruction": "A String", # Optional. System instructions for the judge model.
-          },
-          "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
-            "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
-            "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
-            "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
-              "returnRawOutput": True or False, # Optional. Whether to return raw output.
-            },
-            "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
-            "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
-          },
-          "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
-            "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
-              "returnRawOutput": True or False, # Optional. Whether to return raw output.
-            },
-            "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
-            "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
-          },
-          "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
-            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-              "a_key": "", # Properties of the object.
-            },
-          },
-          "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
-            "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
-            "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
-            "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
-          },
-        },
-      ],
-      "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
-        "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
-          "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
-        },
-      },
-    },
-    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
-    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
-      "adapterSize": "A String", # Optional. Adapter size for tuning.
-      "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
-      "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-      "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
-      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
-    },
-    "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-    "tuningMode": "A String", # Tuning mode.
-    "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-  },
-  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
-    "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
-      { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
-        "checkpointId": "A String", # The ID of the checkpoint.
-        "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-        "epoch": "A String", # The epoch of the checkpoint.
-        "step": "A String", # The step of the checkpoint.
-      },
-    ],
-    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
-  },
-  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
-  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
-    "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
-      "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
-        "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
-          "A String",
-        ],
-        "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
-          "A String",
-        ],
-        "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
-        "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
-        "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
-        "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
-        "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-          { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
-                  "outcome": "A String", # Required. Outcome of the code execution.
-                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
-                },
-                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
-                  "code": "A String", # Required. The code to be executed.
-                  "language": "A String", # Required. Programming language of the `code`.
-                },
-                "fileData": { # URI based data. # Optional. URI based data.
-                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "fileUri": "A String", # Required. URI.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
-                  "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
-                    "a_key": "", # Properties of the object.
-                  },
-                  "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
-                  "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
-                },
-                "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
-                  "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
-                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
-                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
-                    "a_key": "", # Properties of the object.
-                  },
-                },
-                "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                  "data": "A String", # Required. Raw bytes.
-                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "text": "A String", # Optional. Text part (can be code).
-                "thought": True or False, # Optional. Indicates if the part is thought from the model.
-                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
-                  "endOffset": "A String", # Optional. The end offset of the video.
-                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
-                  "startOffset": "A String", # Optional. The start offset of the video.
-                },
-              },
-            ],
-            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-          },
-        ],
-        "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
-          "buckets": [ # Output only. Defines the histogram bucket.
-            { # Dataset bucket used to create a histogram for the distribution given a population of values.
-              "count": "A String", # Output only. Number of values in the bucket.
-              "left": 3.14, # Output only. Left bound of the bucket.
-              "right": 3.14, # Output only. Right bound of the bucket.
-            },
-          ],
-          "max": 3.14, # Output only. The maximum of the population values.
-          "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
-          "median": 3.14, # Output only. The median of the values in the population.
-          "min": 3.14, # Output only. The minimum of the population values.
-          "p5": 3.14, # Output only. The 5th percentile of the values in the population.
-          "p95": 3.14, # Output only. The 95th percentile of the values in the population.
-          "sum": 3.14, # Output only. Sum of a given population of values.
-        },
-        "userMessagePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the messages per example.
-          "buckets": [ # Output only. Defines the histogram bucket.
-            { # Dataset bucket used to create a histogram for the distribution given a population of values.
-              "count": "A String", # Output only. Number of values in the bucket.
-              "left": 3.14, # Output only. Left bound of the bucket.
-              "right": 3.14, # Output only. Right bound of the bucket.
+          ],
+          "max": 3.14, # Output only. The maximum of the population values.
+          "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+          "median": 3.14, # Output only. The median of the values in the population.
+          "min": 3.14, # Output only. The minimum of the population values.
+          "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+          "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+          "sum": 3.14, # Output only. Sum of a given population of values.
+        },
+        "userMessagePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the messages per example.
+          "buckets": [ # Output only. Defines the histogram bucket.
+            { # Dataset bucket used to create a histogram for the distribution given a population of values.
+              "count": "A String", # Output only. Number of values in the bucket.
+              "left": 3.14, # Output only. Left bound of the bucket.
+              "right": 3.14, # Output only. Right bound of the bucket.
             },
           ],
           "max": 3.14, # Output only. The maximum of the population values.
@@ -2598,103 +1946,131 @@ 
Method Details

         { # Input example for preference optimization.
           "completions": [ # List of completions for a given prompt.
             { # Completion and its preference score.
-              "completion": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Single turn completion for the given prompt.
-                "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                  { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+              "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt.
+                "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                  { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                       "outcome": "A String", # Required. Outcome of the code execution.
                       "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                     },
-                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                       "code": "A String", # Required. The code to be executed.
                       "language": "A String", # Required. Programming language of the `code`.
                     },
-                    "fileData": { # URI based data. # Optional. URI based data.
-                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                      "fileUri": "A String", # Required. URI.
+                    "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                      "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                       "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                       "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                         "a_key": "", # Properties of the object.
                       },
                       "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                       "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                     },
-                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                       "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                       "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                      "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                        { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                          "fileData": { # URI based data for function response. # URI based data.
+                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "fileUri": "A String", # Required. URI.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                          "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                            "data": "A String", # Required. Raw bytes.
+                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                        },
+                      ],
                       "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                         "a_key": "", # Properties of the object.
                       },
                     },
-                    "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                      "data": "A String", # Required. Raw bytes.
-                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                      "data": "A String", # Required. The raw bytes of the data.
+                      "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                       "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "text": "A String", # Optional. Text part (can be code).
-                    "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                    "text": "A String", # Optional. The text content of the part.
+                    "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                     "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                    "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                       "endOffset": "A String", # Optional. The end offset of the video.
-                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                       "startOffset": "A String", # Optional. The start offset of the video.
                     },
                   },
                 ],
-                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
               },
               "score": 3.14, # The score for the given completion.
             },
           ],
           "contents": [ # Multi-turn contents that represents the Prompt.
-            { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+            { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+              "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                     "outcome": "A String", # Required. Outcome of the code execution.
                     "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                   },
-                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                     "code": "A String", # Required. The code to be executed.
                     "language": "A String", # Required. Programming language of the `code`.
                   },
-                  "fileData": { # URI based data. # Optional. URI based data.
-                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                    "fileUri": "A String", # Required. URI.
+                  "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                    "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                    "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                     "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                       "a_key": "", # Properties of the object.
                     },
                     "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                     "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                   },
-                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                     "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                     "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                      { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                        "fileData": { # URI based data for function response. # URI based data.
+                          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "fileUri": "A String", # Required. URI.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                        "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                          "data": "A String", # Required. Raw bytes.
+                          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                      },
+                    ],
                     "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                       "a_key": "", # Properties of the object.
                     },
                   },
-                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                    "data": "A String", # Required. Raw bytes.
-                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                    "data": "A String", # Required. The raw bytes of the data.
+                    "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "text": "A String", # Optional. Text part (can be code).
-                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "text": "A String", # Optional. The text content of the part.
+                  "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                   "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                     "endOffset": "A String", # Optional. The end offset of the video.
-                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                     "startOffset": "A String", # Optional. The start offset of the video.
                   },
                 },
               ],
-              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
             },
           ],
         },
@@ -2746,52 +2122,66 @@ 
Method Details

       "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
       "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
       "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-        { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-          "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-              "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+        { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                 "outcome": "A String", # Required. Outcome of the code execution.
                 "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
               },
-              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                 "code": "A String", # Required. The code to be executed.
                 "language": "A String", # Required. Programming language of the `code`.
               },
-              "fileData": { # URI based data. # Optional. URI based data.
-                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                "fileUri": "A String", # Required. URI.
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                 "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
               },
-              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                 "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                   "a_key": "", # Properties of the object.
                 },
                 "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                 "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
               },
-              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                 "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                 "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
                 "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                   "a_key": "", # Properties of the object.
                 },
               },
-              "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                "data": "A String", # Required. Raw bytes.
-                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                 "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
               },
-              "text": "A String", # Optional. Text part (can be code).
-              "thought": True or False, # Optional. Indicates if the part is thought from the model.
+              "text": "A String", # Optional. The text content of the part.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
               "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-              "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                 "endOffset": "A String", # Optional. The end offset of the video.
-                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                 "startOffset": "A String", # Optional. The start offset of the video.
               },
             },
           ],
-          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
         },
       ],
       "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
@@ -2926,6 +2316,9 @@ 
Method Details

               "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric.
                 "score": 3.14, # Output only. Bleu score.
               },
+              "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric.
+                "score": 3.14, # Output only. Custom code execution score.
+              },
               "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric.
                 "score": 3.14, # Output only. Exact match score.
               },
@@ -3005,32 +2398,53 @@ 
Method Details

     "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
   },
   "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
-    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
+    "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
+      "adapterSize": "A String", # Optional. Adapter size for preference optimization.
+      "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+      "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+    },
+    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+  },
+  "satisfiesPzi": True or False, # Output only. Reserved for future use.
+  "satisfiesPzs": True or False, # Output only. Reserved for future use.
+  "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
+  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+  "state": "A String", # Output only. The detailed state of the job.
+  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
       "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
         "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
         "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-        "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-          "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-          "candidateCount": 42, # Optional. Number of candidates to generate.
-          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-          "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-          "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+        "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+          "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+          "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+          "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+          "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
             "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+            "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+              "compressionQuality": 42, # Optional. The compression quality of the output image.
+              "mimeType": "A String", # Optional. The image format that the output should be saved as.
+            },
+            "personGeneration": "A String", # Optional. Controls whether the model can generate people.
           },
-          "logprobs": 42, # Optional. Logit probabilities.
-          "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-          "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+          "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+          "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+          "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
           "modelConfig": { # Config for model selection. # Optional. Config for model selection.
             "featureSelectionPreference": "A String", # Required. Feature selection preference.
           },
-          "presencePenalty": 3.14, # Optional. Positive penalties.
-          "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-          "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-          "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-          "responseModalities": [ # Optional. The modalities of the response.
+          "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+          "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+          "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+          "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+          "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
             "A String",
           ],
-          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
             "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
             "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
               # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -3069,45 +2483,45 @@ 
Method Details

             "title": "A String", # Optional. The title of the Schema.
             "type": "A String", # Optional. The type of the data.
           },
-          "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-            "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+          "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+            "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
               "modelRoutingPreference": "A String", # The model routing preference.
             },
-            "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-              "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+            "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+              "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
             },
           },
-          "seed": 42, # Optional. Seed.
-          "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-            "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+          "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+          "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+            "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
               "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                { # Configuration for a single speaker in a multi speaker setup.
+                { # Configuration for a single speaker in a multi-speaker setup.
                   "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                  "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
+                  "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
                     },
                   },
                 },
               ],
             },
-            "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
+            "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
               },
             },
           },
-          "stopSequences": [ # Optional. Stop sequences.
+          "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
             "A String",
           ],
-          "temperature": 3.14, # Optional. Controls the randomness of predictions.
-          "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-            "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-            "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+          "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+          "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+            "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+            "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
           },
-          "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-          "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+          "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+          "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
         },
         "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
       },
@@ -3119,6 +2533,9 @@ 
Method Details

           "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
             "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
           },
+          "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+            "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```
+          },
           "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
           },
           "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
@@ -3128,28 +2545,33 @@ 
Method Details

             "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
               "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
               "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                "candidateCount": 42, # Optional. Number of candidates to generate.
-                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                   "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                 },
-                "logprobs": 42, # Optional. Logit probabilities.
-                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                 "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                   "featureSelectionPreference": "A String", # Required. Feature selection preference.
                 },
-                "presencePenalty": 3.14, # Optional. Positive penalties.
-                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                "responseModalities": [ # Optional. The modalities of the response.
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                   "A String",
                 ],
-                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                   "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                   "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                     # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -3188,45 +2610,45 @@ 
Method Details

                   "title": "A String", # Optional. The title of the Schema.
                   "type": "A String", # Optional. The type of the data.
                 },
-                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                     "modelRoutingPreference": "A String", # The model routing preference.
                   },
-                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                   },
                 },
-                "seed": 42, # Optional. Seed.
-                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                     "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                      { # Configuration for a single speaker in a multi speaker setup.
+                      { # Configuration for a single speaker in a multi-speaker setup.
                         "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                        "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
                           },
                         },
                       },
                     ],
                   },
-                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
                     },
                   },
                 },
-                "stopSequences": [ # Optional. Stop sequences.
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                   "A String",
                 ],
-                "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                 },
-                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
               },
               "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
             },
@@ -3241,28 +2663,33 @@ 
Method Details

               "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
                 "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
                 "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                  "candidateCount": 42, # Optional. Number of candidates to generate.
-                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                  "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+                "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                  "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                  "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                  "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                     "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                    "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                      "compressionQuality": 42, # Optional. The compression quality of the output image.
+                      "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                    },
+                    "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                   },
-                  "logprobs": 42, # Optional. Logit probabilities.
-                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                  "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                  "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                  "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                   "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                     "featureSelectionPreference": "A String", # Required. Feature selection preference.
                   },
-                  "presencePenalty": 3.14, # Optional. Positive penalties.
-                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                  "responseModalities": [ # Optional. The modalities of the response.
+                  "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                  "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                  "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                  "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                  "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                     "A String",
                   ],
-                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                     "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                     "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                       # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -3301,45 +2728,45 @@ 
Method Details

                     "title": "A String", # Optional. The title of the Schema.
                     "type": "A String", # Optional. The type of the data.
                   },
-                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                  "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                    "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                       "modelRoutingPreference": "A String", # The model routing preference.
                     },
-                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                      "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                     },
                   },
-                  "seed": 42, # Optional. Seed.
-                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                  "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                    "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                       "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                        { # Configuration for a single speaker in a multi speaker setup.
+                        { # Configuration for a single speaker in a multi-speaker setup.
                           "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                          "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                              "voiceName": "A String", # The name of the preset voice to use.
+                          "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                            "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                              "voiceName": "A String", # The name of the prebuilt voice to use.
                             },
                           },
                         },
                       ],
                     },
-                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                        "voiceName": "A String", # The name of the preset voice to use.
+                    "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
                       },
                     },
                   },
-                  "stopSequences": [ # Optional. Stop sequences.
+                  "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                     "A String",
                   ],
-                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                  "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                  "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                    "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                    "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                   },
-                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                  "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                  "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
                 },
                 "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
               },
@@ -3387,513 +2814,129 @@ 
Method Details

         },
       },
     },
-    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
-    "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
-      "adapterSize": "A String", # Optional. Adapter size for preference optimization.
-      "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
+    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+      "adapterSize": "A String", # Optional. Adapter size for tuning.
+      "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
       "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+      "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
     },
-    "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
-    "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+    "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+    "tuningMode": "A String", # Tuning mode.
+    "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
   },
-  "satisfiesPzi": True or False, # Output only. Reserved for future use.
-  "satisfiesPzs": True or False, # Output only. Reserved for future use.
-  "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
-  "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
-  "state": "A String", # Output only. The detailed state of the job.
-  "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
-    "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
-      "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
-        "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-        "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-        "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-          "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-          "candidateCount": 42, # Optional. Number of candidates to generate.
-          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-          "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-          "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-            "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-          },
-          "logprobs": 42, # Optional. Logit probabilities.
-          "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-          "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-          "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-            "featureSelectionPreference": "A String", # Required. Feature selection preference.
-          },
-          "presencePenalty": 3.14, # Optional. Positive penalties.
-          "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-          "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-          "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-          "responseModalities": [ # Optional. The modalities of the response.
-            "A String",
-          ],
-          "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-            "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-            "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-              # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            ],
-            "default": "", # Optional. Default value of the data.
-            "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            },
-            "description": "A String", # Optional. The description of the data.
-            "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-              "A String",
-            ],
-            "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-            "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-            "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-            "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-            "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-            "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-            "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-            "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-            "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-            "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-            "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-            "nullable": True or False, # Optional. Indicates if the value may be null.
-            "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-            "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-              "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-            },
-            "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-              "A String",
-            ],
-            "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-            "required": [ # Optional. Required properties of Type.OBJECT.
-              "A String",
-            ],
-            "title": "A String", # Optional. The title of the Schema.
-            "type": "A String", # Optional. The type of the data.
-          },
-          "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-            "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-              "modelRoutingPreference": "A String", # The model routing preference.
-            },
-            "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-              "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-            },
-          },
-          "seed": 42, # Optional. Seed.
-          "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-            "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-              "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                { # Configuration for a single speaker in a multi speaker setup.
-                  "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                  "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
-                    },
-                  },
-                },
-              ],
-            },
-            "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                "voiceName": "A String", # The name of the preset voice to use.
-              },
-            },
-          },
-          "stopSequences": [ # Optional. Stop sequences.
-            "A String",
-          ],
-          "temperature": 3.14, # Optional. Controls the randomness of predictions.
-          "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-            "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-            "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-          },
-          "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-          "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-        },
-        "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
+    "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
+      { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
+        "checkpointId": "A String", # The ID of the checkpoint.
+        "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+        "epoch": "A String", # The epoch of the checkpoint.
+        "step": "A String", # The step of the checkpoint.
       },
-      "metrics": [ # Required. The metrics used for evaluation.
-        { # The metric used for running evaluations.
-          "aggregationMetrics": [ # Optional. The aggregation metrics to use.
-            "A String",
-          ],
-          "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
-            "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
-          },
-          "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
-          },
-          "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
-            "additionalConfig": { # Optional. Optional additional configuration for the metric.
-              "a_key": "", # Properties of the object.
-            },
-            "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
-              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-              "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                "candidateCount": 42, # Optional. Number of candidates to generate.
-                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+    ],
+    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+  },
+  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
+  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+    "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
+      "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+        "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+          "A String",
+        ],
+        "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+          "A String",
+        ],
+        "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+        "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+        "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+        "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+        "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+          { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+            "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+              { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+                  "outcome": "A String", # Required. Outcome of the code execution.
+                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                 },
-                "logprobs": 42, # Optional. Logit probabilities.
-                "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                  "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                  "code": "A String", # Required. The code to be executed.
+                  "language": "A String", # Required. Programming language of the `code`.
                 },
-                "presencePenalty": 3.14, # Optional. Positive penalties.
-                "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                "responseModalities": [ # Optional. The modalities of the response.
-                  "A String",
-                ],
-                "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                  "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                  "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                    # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  ],
-                  "default": "", # Optional. Default value of the data.
-                  "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  },
-                  "description": "A String", # Optional. The description of the data.
-                  "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                    "A String",
-                  ],
-                  "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                  "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                  "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                  "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                  "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                  "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                  "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                  "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                  "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                  "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                  "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                  "nullable": True or False, # Optional. Indicates if the value may be null.
-                  "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                  "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                    "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                  },
-                  "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                    "A String",
-                  ],
-                  "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                  "required": [ # Optional. Required properties of Type.OBJECT.
-                    "A String",
-                  ],
-                  "title": "A String", # Optional. The title of the Schema.
-                  "type": "A String", # Optional. The type of the data.
+                "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                  "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                  "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                 },
-                "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                  "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                    "modelRoutingPreference": "A String", # The model routing preference.
-                  },
-                  "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                    "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                  "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                    "a_key": "", # Properties of the object.
                   },
+                  "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                  "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                 },
-                "seed": 42, # Optional. Seed.
-                "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                  "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                      { # Configuration for a single speaker in a multi speaker setup.
-                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                        "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
-                          },
-                        },
+                "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                  "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                  "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                    { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                      "fileData": { # URI based data for function response. # URI based data.
+                        "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "fileUri": "A String", # Required. URI.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                      },
+                      "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                        "data": "A String", # Required. Raw bytes.
+                        "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                       },
-                    ],
-                  },
-                  "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                    "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                      "voiceName": "A String", # The name of the preset voice to use.
                     },
+                  ],
+                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                    "a_key": "", # Properties of the object.
                   },
                 },
-                "stopSequences": [ # Optional. Stop sequences.
-                  "A String",
-                ],
-                "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                  "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                  "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                  "data": "A String", # Required. The raw bytes of the data.
+                  "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                },
+                "text": "A String", # Optional. The text content of the part.
+                "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "endOffset": "A String", # Optional. The end offset of the video.
+                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                  "startOffset": "A String", # Optional. The start offset of the video.
                 },
-                "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
               },
-              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+            ],
+            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+          },
+        ],
+        "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
+          "buckets": [ # Output only. Defines the histogram bucket.
+            { # Dataset bucket used to create a histogram for the distribution given a population of values.
+              "count": "A String", # Output only. Number of values in the bucket.
+              "left": 3.14, # Output only. Left bound of the bucket.
+              "right": 3.14, # Output only. Right bound of the bucket.
             },
-            "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
-            "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
-              "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-              "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-                "a_key": "", # Properties of the object.
-              },
-            },
-            "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
-              "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
-                "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-                "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                  "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                  "candidateCount": 42, # Optional. Number of candidates to generate.
-                  "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                  "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                  "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                    "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-                  },
-                  "logprobs": 42, # Optional. Logit probabilities.
-                  "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                  "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                  "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                    "featureSelectionPreference": "A String", # Required. Feature selection preference.
-                  },
-                  "presencePenalty": 3.14, # Optional. Positive penalties.
-                  "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                  "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                  "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                  "responseModalities": [ # Optional. The modalities of the response.
-                    "A String",
-                  ],
-                  "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                    "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                    "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                      # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    ],
-                    "default": "", # Optional. Default value of the data.
-                    "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    },
-                    "description": "A String", # Optional. The description of the data.
-                    "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                      "A String",
-                    ],
-                    "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                    "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                    "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                    "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                    "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                    "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                    "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                    "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                    "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                    "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                    "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                    "nullable": True or False, # Optional. Indicates if the value may be null.
-                    "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                    "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                      "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                    },
-                    "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                      "A String",
-                    ],
-                    "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                    "required": [ # Optional. Required properties of Type.OBJECT.
-                      "A String",
-                    ],
-                    "title": "A String", # Optional. The title of the Schema.
-                    "type": "A String", # Optional. The type of the data.
-                  },
-                  "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                    "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                      "modelRoutingPreference": "A String", # The model routing preference.
-                    },
-                    "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                      "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-                    },
-                  },
-                  "seed": 42, # Optional. Seed.
-                  "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                    "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                    "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                      "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                        { # Configuration for a single speaker in a multi speaker setup.
-                          "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                          "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                            "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                              "voiceName": "A String", # The name of the preset voice to use.
-                            },
-                          },
-                        },
-                      ],
-                    },
-                    "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                      "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                        "voiceName": "A String", # The name of the preset voice to use.
-                      },
-                    },
-                  },
-                  "stopSequences": [ # Optional. Stop sequences.
-                    "A String",
-                  ],
-                  "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                  "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                    "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                    "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-                  },
-                  "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                  "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-                },
-                "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
-              },
-              "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
-              "rubricContentType": "A String", # The type of rubric content to be generated.
-              "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
-                "A String",
-              ],
-            },
-            "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
-            "systemInstruction": "A String", # Optional. System instructions for the judge model.
-          },
-          "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
-            "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
-            "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
-            "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
-              "returnRawOutput": True or False, # Optional. Whether to return raw output.
-            },
-            "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
-            "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
-          },
-          "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
-            "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
-              "returnRawOutput": True or False, # Optional. Whether to return raw output.
-            },
-            "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
-            "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
-          },
-          "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
-            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-              "a_key": "", # Properties of the object.
-            },
-          },
-          "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
-            "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
-            "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
-            "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
-          },
-        },
-      ],
-      "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
-        "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
-          "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
-        },
-      },
-    },
-    "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
-    "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
-      "adapterSize": "A String", # Optional. Adapter size for tuning.
-      "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
-      "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-      "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
-      "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
-    },
-    "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-    "tuningMode": "A String", # Tuning mode.
-    "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-  },
-  "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
-    "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
-      { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
-        "checkpointId": "A String", # The ID of the checkpoint.
-        "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-        "epoch": "A String", # The epoch of the checkpoint.
-        "step": "A String", # The step of the checkpoint.
-      },
-    ],
-    "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-    "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
-  },
-  "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
-  "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
-    "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
-      "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
-        "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
-          "A String",
-        ],
-        "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
-          "A String",
-        ],
-        "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
-        "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
-        "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
-        "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
-        "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-          { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-            "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-              { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
-                  "outcome": "A String", # Required. Outcome of the code execution.
-                  "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
-                },
-                "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
-                  "code": "A String", # Required. The code to be executed.
-                  "language": "A String", # Required. Programming language of the `code`.
-                },
-                "fileData": { # URI based data. # Optional. URI based data.
-                  "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "fileUri": "A String", # Required. URI.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
-                  "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
-                    "a_key": "", # Properties of the object.
-                  },
-                  "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
-                  "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
-                },
-                "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
-                  "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
-                  "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
-                  "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
-                    "a_key": "", # Properties of the object.
-                  },
-                },
-                "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                  "data": "A String", # Required. Raw bytes.
-                  "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                  "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                },
-                "text": "A String", # Optional. Text part (can be code).
-                "thought": True or False, # Optional. Indicates if the part is thought from the model.
-                "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
-                  "endOffset": "A String", # Optional. The end offset of the video.
-                  "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
-                  "startOffset": "A String", # Optional. The start offset of the video.
-                },
-              },
-            ],
-            "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
-          },
-        ],
-        "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
-          "buckets": [ # Output only. Defines the histogram bucket.
-            { # Dataset bucket used to create a histogram for the distribution given a population of values.
-              "count": "A String", # Output only. Number of values in the bucket.
-              "left": 3.14, # Output only. Left bound of the bucket.
-              "right": 3.14, # Output only. Right bound of the bucket.
-            },
-          ],
-          "max": 3.14, # Output only. The maximum of the population values.
-          "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
-          "median": 3.14, # Output only. The median of the values in the population.
-          "min": 3.14, # Output only. The minimum of the population values.
-          "p5": 3.14, # Output only. The 5th percentile of the values in the population.
-          "p95": 3.14, # Output only. The 95th percentile of the values in the population.
-          "sum": 3.14, # Output only. Sum of a given population of values.
-        },
-        "userMessagePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the messages per example.
-          "buckets": [ # Output only. Defines the histogram bucket.
-            { # Dataset bucket used to create a histogram for the distribution given a population of values.
-              "count": "A String", # Output only. Number of values in the bucket.
-              "left": 3.14, # Output only. Left bound of the bucket.
-              "right": 3.14, # Output only. Right bound of the bucket.
+          ],
+          "max": 3.14, # Output only. The maximum of the population values.
+          "mean": 3.14, # Output only. The arithmetic mean of the values in the population.
+          "median": 3.14, # Output only. The median of the values in the population.
+          "min": 3.14, # Output only. The minimum of the population values.
+          "p5": 3.14, # Output only. The 5th percentile of the values in the population.
+          "p95": 3.14, # Output only. The 95th percentile of the values in the population.
+          "sum": 3.14, # Output only. Sum of a given population of values.
+        },
+        "userMessagePerExampleDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the messages per example.
+          "buckets": [ # Output only. Defines the histogram bucket.
+            { # Dataset bucket used to create a histogram for the distribution given a population of values.
+              "count": "A String", # Output only. Number of values in the bucket.
+              "left": 3.14, # Output only. Left bound of the bucket.
+              "right": 3.14, # Output only. Right bound of the bucket.
             },
           ],
           "max": 3.14, # Output only. The maximum of the population values.
@@ -3968,103 +3011,131 @@ 
Method Details

         { # Input example for preference optimization.
           "completions": [ # List of completions for a given prompt.
             { # Completion and its preference score.
-              "completion": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Single turn completion for the given prompt.
-                "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                  { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+              "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt.
+                "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                  { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                       "outcome": "A String", # Required. Outcome of the code execution.
                       "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                     },
-                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                       "code": "A String", # Required. The code to be executed.
                       "language": "A String", # Required. Programming language of the `code`.
                     },
-                    "fileData": { # URI based data. # Optional. URI based data.
-                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                      "fileUri": "A String", # Required. URI.
+                    "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                      "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                       "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                       "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                         "a_key": "", # Properties of the object.
                       },
                       "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                       "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                     },
-                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                       "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                       "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                      "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                        { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                          "fileData": { # URI based data for function response. # URI based data.
+                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "fileUri": "A String", # Required. URI.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                          "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                            "data": "A String", # Required. Raw bytes.
+                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                          },
+                        },
+                      ],
                       "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                         "a_key": "", # Properties of the object.
                       },
                     },
-                    "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                      "data": "A String", # Required. Raw bytes.
-                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                      "data": "A String", # Required. The raw bytes of the data.
+                      "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                       "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "text": "A String", # Optional. Text part (can be code).
-                    "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                    "text": "A String", # Optional. The text content of the part.
+                    "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                     "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                    "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                    "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                       "endOffset": "A String", # Optional. The end offset of the video.
-                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                       "startOffset": "A String", # Optional. The start offset of the video.
                     },
                   },
                 ],
-                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
               },
               "score": 3.14, # The score for the given completion.
             },
           ],
           "contents": [ # Multi-turn contents that represents the Prompt.
-            { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+            { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+              "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                     "outcome": "A String", # Required. Outcome of the code execution.
                     "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                   },
-                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                     "code": "A String", # Required. The code to be executed.
                     "language": "A String", # Required. Programming language of the `code`.
                   },
-                  "fileData": { # URI based data. # Optional. URI based data.
-                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                    "fileUri": "A String", # Required. URI.
+                  "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                    "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                    "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                     "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                       "a_key": "", # Properties of the object.
                     },
                     "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                     "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                   },
-                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                     "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                     "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                      { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                        "fileData": { # URI based data for function response. # URI based data.
+                          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "fileUri": "A String", # Required. URI.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                        "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                          "data": "A String", # Required. Raw bytes.
+                          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                      },
+                    ],
                     "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                       "a_key": "", # Properties of the object.
                     },
                   },
-                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                    "data": "A String", # Required. Raw bytes.
-                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                    "data": "A String", # Required. The raw bytes of the data.
+                    "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "text": "A String", # Optional. Text part (can be code).
-                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "text": "A String", # Optional. The text content of the part.
+                  "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                   "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                     "endOffset": "A String", # Optional. The end offset of the video.
-                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                     "startOffset": "A String", # Optional. The start offset of the video.
                   },
                 },
               ],
-              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
             },
           ],
         },
@@ -4116,52 +3187,66 @@ 
Method Details

       "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
       "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
       "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-        { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-          "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-            { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-              "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+        { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+          "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+            { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+              "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                 "outcome": "A String", # Required. Outcome of the code execution.
                 "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
               },
-              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+              "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                 "code": "A String", # Required. The code to be executed.
                 "language": "A String", # Required. Programming language of the `code`.
               },
-              "fileData": { # URI based data. # Optional. URI based data.
-                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                "fileUri": "A String", # Required. URI.
+              "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                 "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
               },
-              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+              "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                 "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                   "a_key": "", # Properties of the object.
                 },
                 "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                 "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
               },
-              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+              "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                 "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                 "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                  { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                    "fileData": { # URI based data for function response. # URI based data.
+                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "fileUri": "A String", # Required. URI.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                      "data": "A String", # Required. Raw bytes.
+                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                  },
+                ],
                 "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                   "a_key": "", # Properties of the object.
                 },
               },
-              "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                "data": "A String", # Required. Raw bytes.
-                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+              "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                "data": "A String", # Required. The raw bytes of the data.
+                "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                 "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
               },
-              "text": "A String", # Optional. Text part (can be code).
-              "thought": True or False, # Optional. Indicates if the part is thought from the model.
+              "text": "A String", # Optional. The text content of the part.
+              "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
               "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-              "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+              "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                 "endOffset": "A String", # Optional. The end offset of the video.
-                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                 "startOffset": "A String", # Optional. The start offset of the video.
               },
             },
           ],
-          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+          "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
         },
       ],
       "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
@@ -4302,6 +3387,9 @@ 
Method Details

                   "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric.
                     "score": 3.14, # Output only. Bleu score.
                   },
+                  "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric.
+                    "score": 3.14, # Output only. Custom code execution score.
+                  },
                   "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric.
                     "score": 3.14, # Output only. Exact match score.
                   },
@@ -4381,32 +3469,53 @@ 
Method Details

         "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}`
       },
       "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization.
-        "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job.
+        "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
+        "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
+          "adapterSize": "A String", # Optional. Adapter size for preference optimization.
+          "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+          "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
+          "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+        },
+        "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+        "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+      },
+      "satisfiesPzi": True or False, # Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Output only. Reserved for future use.
+      "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
+      "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
+      "state": "A String", # Output only. The detailed state of the job.
+      "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
+        "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
           "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
             "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
             "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-              "candidateCount": 42, # Optional. Number of candidates to generate.
-              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-              "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+            "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+              "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+              "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+              "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                 "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                  "compressionQuality": 42, # Optional. The compression quality of the output image.
+                  "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                },
+                "personGeneration": "A String", # Optional. Controls whether the model can generate people.
               },
-              "logprobs": 42, # Optional. Logit probabilities.
-              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+              "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+              "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+              "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
               "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                 "featureSelectionPreference": "A String", # Required. Feature selection preference.
               },
-              "presencePenalty": 3.14, # Optional. Positive penalties.
-              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-              "responseModalities": [ # Optional. The modalities of the response.
+              "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+              "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+              "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+              "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+              "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                 "A String",
               ],
-              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                 "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                 "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                   # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -4445,45 +3554,45 @@ 
Method Details

                 "title": "A String", # Optional. The title of the Schema.
                 "type": "A String", # Optional. The type of the data.
               },
-              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+              "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                   "modelRoutingPreference": "A String", # The model routing preference.
                 },
-                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                  "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                 },
               },
-              "seed": 42, # Optional. Seed.
-              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+              "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+              "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                   "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                    { # Configuration for a single speaker in a multi speaker setup.
+                    { # Configuration for a single speaker in a multi-speaker setup.
                       "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                      "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                          "voiceName": "A String", # The name of the preset voice to use.
+                      "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
                         },
                       },
                     },
                   ],
                 },
-                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                    "voiceName": "A String", # The name of the preset voice to use.
+                "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                  "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                    "voiceName": "A String", # The name of the prebuilt voice to use.
                   },
                 },
               },
-              "stopSequences": [ # Optional. Stop sequences.
+              "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                 "A String",
               ],
-              "temperature": 3.14, # Optional. Controls the randomness of predictions.
-              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+              "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+              "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
               },
-              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+              "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+              "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
             },
             "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
           },
@@ -4495,6 +3604,9 @@ 
Method Details

               "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
                 "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
               },
+              "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+                "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```
+              },
               "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
               },
               "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
@@ -4504,28 +3616,33 @@ 
Method Details

                 "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
                   "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
                   "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                  "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                    "candidateCount": 42, # Optional. Number of candidates to generate.
-                    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                    "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+                  "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                    "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                    "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                    "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                    "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                       "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                      "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                        "compressionQuality": 42, # Optional. The compression quality of the output image.
+                        "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                      },
+                      "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                     },
-                    "logprobs": 42, # Optional. Logit probabilities.
-                    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                    "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                    "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                    "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                     "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                       "featureSelectionPreference": "A String", # Required. Feature selection preference.
                     },
-                    "presencePenalty": 3.14, # Optional. Positive penalties.
-                    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                    "responseModalities": [ # Optional. The modalities of the response.
+                    "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                    "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                    "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                    "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                    "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                       "A String",
                     ],
-                    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                       "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                       "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                         # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -4564,45 +3681,45 @@ 
Method Details

                       "title": "A String", # Optional. The title of the Schema.
                       "type": "A String", # Optional. The type of the data.
                     },
-                    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                    "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                      "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                         "modelRoutingPreference": "A String", # The model routing preference.
                       },
-                      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                      "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                        "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                       },
                     },
-                    "seed": 42, # Optional. Seed.
-                    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                    "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                    "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                      "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                         "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                          { # Configuration for a single speaker in a multi speaker setup.
+                          { # Configuration for a single speaker in a multi-speaker setup.
                             "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                            "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                                "voiceName": "A String", # The name of the preset voice to use.
+                            "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                                "voiceName": "A String", # The name of the prebuilt voice to use.
                               },
                             },
                           },
                         ],
                       },
-                      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                          "voiceName": "A String", # The name of the preset voice to use.
+                      "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
                         },
                       },
                     },
-                    "stopSequences": [ # Optional. Stop sequences.
+                    "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                       "A String",
                     ],
-                    "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                    "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                    "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                      "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                      "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                     },
-                    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                    "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                    "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
                   },
                   "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
                 },
@@ -4617,28 +3734,33 @@ 
Method Details

                   "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
                     "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
                     "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                    "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                      "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                      "candidateCount": 42, # Optional. Number of candidates to generate.
-                      "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                      "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                      "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
+                    "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                      "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                      "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                      "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                      "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                      "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features.
                         "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                        "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                          "compressionQuality": 42, # Optional. The compression quality of the output image.
+                          "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                        },
+                        "personGeneration": "A String", # Optional. Controls whether the model can generate people.
                       },
-                      "logprobs": 42, # Optional. Logit probabilities.
-                      "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                      "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
+                      "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                      "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                      "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
                       "modelConfig": { # Config for model selection. # Optional. Config for model selection.
                         "featureSelectionPreference": "A String", # Required. Feature selection preference.
                       },
-                      "presencePenalty": 3.14, # Optional. Positive penalties.
-                      "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                      "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                      "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                      "responseModalities": [ # Optional. The modalities of the response.
+                      "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                      "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.
+                      "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                      "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
+                      "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
                         "A String",
                       ],
-                      "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
+                      "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`.
                         "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
                         "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
                           # Object with schema name: GoogleCloudAiplatformV1beta1Schema
@@ -4677,45 +3799,45 @@ 
Method Details

                         "title": "A String", # Optional. The title of the Schema.
                         "type": "A String", # Optional. The type of the data.
                       },
-                      "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                        "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
+                      "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                        "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
                           "modelRoutingPreference": "A String", # The model routing preference.
                         },
-                        "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                          "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                        "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                          "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
                         },
                       },
-                      "seed": 42, # Optional. Seed.
-                      "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                        "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                        "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                      "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                      "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                        "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                        "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
                           "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                            { # Configuration for a single speaker in a multi speaker setup.
+                            { # Configuration for a single speaker in a multi-speaker setup.
                               "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                              "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                                "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                                  "voiceName": "A String", # The name of the preset voice to use.
+                              "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                                "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                                  "voiceName": "A String", # The name of the prebuilt voice to use.
                                 },
                               },
                             },
                           ],
                         },
-                        "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
+                        "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
                           },
                         },
                       },
-                      "stopSequences": [ # Optional. Stop sequences.
+                      "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
                         "A String",
                       ],
-                      "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                      "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                        "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                        "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                      "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                      "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                        "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                        "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
                       },
-                      "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                      "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
+                      "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                      "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
                     },
                     "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
                   },
@@ -4763,489 +3885,105 @@ 
Method Details

             },
           },
         },
-        "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.
-        "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization.
-          "adapterSize": "A String", # Optional. Adapter size for preference optimization.
-          "beta": 3.14, # Optional. Weight for KL Divergence regularization.
+        "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
+        "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
+          "adapterSize": "A String", # Optional. Adapter size for tuning.
+          "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
           "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-          "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate.
+          "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
+          "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
         },
-        "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
-        "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.
+        "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
+        "tuningMode": "A String", # Tuning mode.
+        "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
       },
-      "satisfiesPzi": True or False, # Output only. Reserved for future use.
-      "satisfiesPzs": True or False, # Output only. Reserved for future use.
-      "serviceAccount": "A String", # The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
-      "startTime": "A String", # Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.
-      "state": "A String", # Output only. The detailed state of the job.
-      "supervisedTuningSpec": { # Tuning Spec for Supervised Tuning for first party models. # Tuning Spec for Supervised Fine Tuning.
-        "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Tuning Job.
-          "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation.
-            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-            "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-            "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-              "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-              "candidateCount": 42, # Optional. Number of candidates to generate.
-              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-              "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-              "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-              },
-              "logprobs": 42, # Optional. Logit probabilities.
-              "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-              "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-              "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                "featureSelectionPreference": "A String", # Required. Feature selection preference.
-              },
-              "presencePenalty": 3.14, # Optional. Positive penalties.
-              "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-              "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-              "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-              "responseModalities": [ # Optional. The modalities of the response.
-                "A String",
-              ],
-              "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                  # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                ],
-                "default": "", # Optional. Default value of the data.
-                "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                },
-                "description": "A String", # Optional. The description of the data.
-                "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                  "A String",
-                ],
-                "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                "nullable": True or False, # Optional. Indicates if the value may be null.
-                "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                  "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                },
-                "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                  "A String",
-                ],
-                "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                "required": [ # Optional. Required properties of Type.OBJECT.
-                  "A String",
-                ],
-                "title": "A String", # Optional. The title of the Schema.
-                "type": "A String", # Optional. The type of the data.
-              },
-              "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                  "modelRoutingPreference": "A String", # The model routing preference.
-                },
-                "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                  "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-                },
-              },
-              "seed": 42, # Optional. Seed.
-              "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                  "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                    { # Configuration for a single speaker in a multi speaker setup.
-                      "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                      "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                          "voiceName": "A String", # The name of the preset voice to use.
-                        },
-                      },
-                    },
-                  ],
-                },
-                "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                  "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                    "voiceName": "A String", # The name of the preset voice to use.
-                  },
-                },
-              },
-              "stopSequences": [ # Optional. Stop sequences.
-                "A String",
-              ],
-              "temperature": 3.14, # Optional. Controls the randomness of predictions.
-              "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-              },
-              "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-              "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-            },
-            "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+      "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
+        "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
+          { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
+            "checkpointId": "A String", # The ID of the checkpoint.
+            "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+            "epoch": "A String", # The epoch of the checkpoint.
+            "step": "A String", # The step of the checkpoint.
           },
-          "metrics": [ # Required. The metrics used for evaluation.
-            { # The metric used for running evaluations.
-              "aggregationMetrics": [ # Optional. The aggregation metrics to use.
-                "A String",
-              ],
-              "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
-                "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
-              },
-              "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
-              },
-              "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
-                "additionalConfig": { # Optional. Optional additional configuration for the metric.
-                  "a_key": "", # Properties of the object.
-                },
-                "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
-                  "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-                  "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                  "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                    "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                    "candidateCount": 42, # Optional. Number of candidates to generate.
-                    "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                    "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                    "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                      "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+        ],
+        "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
+        "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
+      },
+      "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
+      "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
+        "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
+          "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
+            "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
+              "A String",
+            ],
+            "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
+              "A String",
+            ],
+            "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
+            "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
+            "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
+            "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
+            "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
+              { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+                "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                  { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
+                      "outcome": "A String", # Required. Outcome of the code execution.
+                      "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                     },
-                    "logprobs": 42, # Optional. Logit probabilities.
-                    "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                    "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                    "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                      "featureSelectionPreference": "A String", # Required. Feature selection preference.
+                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                      "code": "A String", # Required. The code to be executed.
+                      "language": "A String", # Required. Programming language of the `code`.
                     },
-                    "presencePenalty": 3.14, # Optional. Positive penalties.
-                    "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                    "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                    "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                    "responseModalities": [ # Optional. The modalities of the response.
-                      "A String",
-                    ],
-                    "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                      "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                      "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                        # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                      ],
-                      "default": "", # Optional. Default value of the data.
-                      "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                      },
-                      "description": "A String", # Optional. The description of the data.
-                      "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                        "A String",
-                      ],
-                      "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                      "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                      "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                      "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                      "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                      "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                      "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                      "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                      "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                      "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                      "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                      "nullable": True or False, # Optional. Indicates if the value may be null.
-                      "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                      "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                        "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                      },
-                      "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                        "A String",
-                      ],
-                      "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                      "required": [ # Optional. Required properties of Type.OBJECT.
-                        "A String",
-                      ],
-                      "title": "A String", # Optional. The title of the Schema.
-                      "type": "A String", # Optional. The type of the data.
+                    "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                      "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                     },
-                    "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                      "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                        "modelRoutingPreference": "A String", # The model routing preference.
-                      },
-                      "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                        "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                      "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
+                        "a_key": "", # Properties of the object.
                       },
+                      "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
+                      "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                     },
-                    "seed": 42, # Optional. Seed.
-                    "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                      "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                      "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                        "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                          { # Configuration for a single speaker in a multi speaker setup.
-                            "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                            "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                              "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                                "voiceName": "A String", # The name of the preset voice to use.
-                              },
-                            },
+                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                      "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
+                      "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                      "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                        { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                          "fileData": { # URI based data for function response. # URI based data.
+                            "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "fileUri": "A String", # Required. URI.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                           },
-                        ],
-                      },
-                      "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                        "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                          "voiceName": "A String", # The name of the preset voice to use.
-                        },
-                      },
-                    },
-                    "stopSequences": [ # Optional. Stop sequences.
-                      "A String",
-                    ],
-                    "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                    "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                      "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                      "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
-                    },
-                    "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                    "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
-                  },
-                  "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
-                },
-                "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
-                "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
-                  "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-                  "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-                    "a_key": "", # Properties of the object.
-                  },
-                },
-                "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
-                  "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
-                    "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
-                    "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
-                    "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs.
-                      "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model.
-                      "candidateCount": 42, # Optional. Number of candidates to generate.
-                      "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly.
-                      "frequencyPenalty": 3.14, # Optional. Frequency penalties.
-                      "imageConfig": { # Config for image generation features. # Optional. Config for image generation features.
-                        "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
-                      },
-                      "logprobs": 42, # Optional. Logit probabilities.
-                      "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
-                      "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used.
-                      "modelConfig": { # Config for model selection. # Optional. Config for model selection.
-                        "featureSelectionPreference": "A String", # Required. Feature selection preference.
-                      },
-                      "presencePenalty": 3.14, # Optional. Positive penalties.
-                      "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.
-                      "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response.
-                      "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
-                      "responseModalities": [ # Optional. The modalities of the response.
-                        "A String",
-                      ],
-                      "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
-                        "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties.
-                        "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
-                          # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                        ],
-                        "default": "", # Optional. Default value of the data.
-                        "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema.
-                          "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                        },
-                        "description": "A String", # Optional. The description of the data.
-                        "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
-                          "A String",
-                        ],
-                        "example": "", # Optional. Example of the object. Will only populated when the object is the root.
-                        "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
-                        "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
-                        "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
-                        "maxLength": "A String", # Optional. Maximum length of the Type.STRING
-                        "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
-                        "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
-                        "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
-                        "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
-                        "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
-                        "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
-                        "nullable": True or False, # Optional. Indicates if the value may be null.
-                        "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
-                        "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
-                          "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
-                        },
-                        "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.
-                          "A String",
-                        ],
-                        "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
-                        "required": [ # Optional. Required properties of Type.OBJECT.
-                          "A String",
-                        ],
-                        "title": "A String", # Optional. The title of the Schema.
-                        "type": "A String", # Optional. The type of the data.
-                      },
-                      "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration.
-                        "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing.
-                          "modelRoutingPreference": "A String", # The model routing preference.
-                        },
-                        "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing.
-                          "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
-                        },
-                      },
-                      "seed": 42, # Optional. Seed.
-                      "speechConfig": { # The speech generation config. # Optional. The speech generation config.
-                        "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.
-                        "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
-                          "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
-                            { # Configuration for a single speaker in a multi speaker setup.
-                              "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
-                              "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker.
-                                "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                                  "voiceName": "A String", # The name of the preset voice to use.
-                                },
-                              },
-                            },
-                          ],
-                        },
-                        "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use.
-                          "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use.
-                            "voiceName": "A String", # The name of the preset voice to use.
+                          "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                            "data": "A String", # Required. Raw bytes.
+                            "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                            "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                           },
                         },
-                      },
-                      "stopSequences": [ # Optional. Stop sequences.
-                        "A String",
                       ],
-                      "temperature": 3.14, # Optional. Controls the randomness of predictions.
-                      "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.
-                        "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.
-                        "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens.
+                      "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                        "a_key": "", # Properties of the object.
                       },
-                      "topK": 3.14, # Optional. If specified, top-k sampling will be used.
-                      "topP": 3.14, # Optional. If specified, nucleus sampling will be used.
                     },
-                    "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+                    "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                      "data": "A String", # Required. The raw bytes of the data.
+                      "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                    },
+                    "text": "A String", # Optional. The text content of the part.
+                    "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                    "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                    "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                      "endOffset": "A String", # Optional. The end offset of the video.
+                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                      "startOffset": "A String", # Optional. The start offset of the video.
+                    },
                   },
-                  "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
-                  "rubricContentType": "A String", # The type of rubric content to be generated.
-                  "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
-                    "A String",
-                  ],
-                },
-                "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
-                "systemInstruction": "A String", # Optional. System instructions for the judge model.
-              },
-              "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
-                "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
-                "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
-                "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
-                  "returnRawOutput": True or False, # Optional. Whether to return raw output.
-                },
-                "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
-                "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
-              },
-              "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
-                "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
-                  "returnRawOutput": True or False, # Optional. Whether to return raw output.
-                },
-                "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
-                "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
-              },
-              "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
-                "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
-                "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
-                  "a_key": "", # Properties of the object.
-                },
-              },
-              "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
-                "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
-                "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
-                "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
-              },
-            },
-          ],
-          "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output.
-            "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output.
-              "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
-            },
-          },
-        },
-        "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for SFT and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for SFT. Default is false.
-        "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for SFT.
-          "adapterSize": "A String", # Optional. Adapter size for tuning.
-          "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models.
-          "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training.
-          "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models.
-          "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models.
-        },
-        "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-        "tuningMode": "A String", # Tuning mode.
-        "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset.
-      },
-      "tunedModel": { # The Model Registry Model and Online Prediction Endpoint associated with this TuningJob. # Output only. The tuned model resources associated with this TuningJob.
-        "checkpoints": [ # Output only. The checkpoints associated with this TunedModel. This field is only populated for tuning jobs that enable intermediate checkpoints.
-          { # TunedModelCheckpoint for the Tuned Model of a Tuning Job.
-            "checkpointId": "A String", # The ID of the checkpoint.
-            "endpoint": "A String", # The Endpoint resource name that the checkpoint is deployed to. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-            "epoch": "A String", # The epoch of the checkpoint.
-            "step": "A String", # The step of the checkpoint.
-          },
-        ],
-        "endpoint": "A String", # Output only. A resource name of an Endpoint. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`.
-        "model": "A String", # Output only. The resource name of the TunedModel. Format: `projects/{project}/locations/{location}/models/{model}@{version_id}` When tuning from a base model, the version ID will be 1. For continuous tuning, if the provided tuned_model_display_name is set and different from parent model's display name, the tuned model will have a new parent model with version 1. Otherwise the version id will be incremented by 1 from the last version ID in the parent model. E.g., `projects/{project}/locations/{location}/models/{model}@{last_version_id + 1}`
-      },
-      "tunedModelDisplayName": "A String", # Optional. The display name of the TunedModel. The name can be up to 128 characters long and can consist of any UTF-8 characters. For continuous tuning, tuned_model_display_name will by default use the same display name as the pre-tuned model. If a new display name is provided, the tuning job will create a new model instead of a new version.
-      "tuningDataStats": { # The tuning data statistic values for TuningJob. # Output only. The tuning data statistics associated with this TuningJob.
-        "distillationDataStats": { # Statistics computed for datasets used for distillation. # Output only. Statistics for distillation.
-          "trainingDatasetStats": { # Statistics computed over a tuning dataset. # Output only. Statistics computed for the training dataset.
-            "droppedExampleIndices": [ # Output only. A partial sample of the indices (starting from 1) of the dropped examples.
-              "A String",
-            ],
-            "droppedExampleReasons": [ # Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.
-              "A String",
-            ],
-            "totalBillableCharacterCount": "A String", # Output only. Number of billable characters in the tuning dataset.
-            "totalTuningCharacterCount": "A String", # Output only. Number of tuning characters in the tuning dataset.
-            "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
-            "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
-            "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-              { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-                "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                  { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                    "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
-                      "outcome": "A String", # Required. Outcome of the code execution.
-                      "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
-                    },
-                    "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
-                      "code": "A String", # Required. The code to be executed.
-                      "language": "A String", # Required. Programming language of the `code`.
-                    },
-                    "fileData": { # URI based data. # Optional. URI based data.
-                      "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                      "fileUri": "A String", # Required. URI.
-                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                    },
-                    "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
-                      "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
-                        "a_key": "", # Properties of the object.
-                      },
-                      "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
-                      "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
-                    },
-                    "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
-                      "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
-                      "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
-                      "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
-                        "a_key": "", # Properties of the object.
-                      },
-                    },
-                    "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                      "data": "A String", # Required. Raw bytes.
-                      "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                      "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
-                    },
-                    "text": "A String", # Optional. Text part (can be code).
-                    "thought": True or False, # Optional. Indicates if the part is thought from the model.
-                    "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                    "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
-                      "endOffset": "A String", # Optional. The end offset of the video.
-                      "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
-                      "startOffset": "A String", # Optional. The start offset of the video.
-                    },
-                  },
-                ],
-                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                ],
+                "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
               },
             ],
             "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens.
@@ -5344,103 +4082,131 @@ 
Method Details

             { # Input example for preference optimization.
               "completions": [ # List of completions for a given prompt.
                 { # Completion and its preference score.
-                  "completion": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Single turn completion for the given prompt.
-                    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                  "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt.
+                    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                           "outcome": "A String", # Required. Outcome of the code execution.
                           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                         },
-                        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                           "code": "A String", # Required. The code to be executed.
                           "language": "A String", # Required. Programming language of the `code`.
                         },
-                        "fileData": { # URI based data. # Optional. URI based data.
-                          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                          "fileUri": "A String", # Required. URI.
+                        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                         },
-                        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                             "a_key": "", # Properties of the object.
                           },
                           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                         },
-                        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                              "fileData": { # URI based data for function response. # URI based data.
+                                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                "fileUri": "A String", # Required. URI.
+                                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                              },
+                              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                "data": "A String", # Required. Raw bytes.
+                                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                              },
+                            },
+                          ],
                           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                             "a_key": "", # Properties of the object.
                           },
                         },
-                        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                          "data": "A String", # Required. Raw bytes.
-                          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                          "data": "A String", # Required. The raw bytes of the data.
+                          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                         },
-                        "text": "A String", # Optional. Text part (can be code).
-                        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                        "text": "A String", # Optional. The text content of the part.
+                        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                           "endOffset": "A String", # Optional. The end offset of the video.
-                          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                           "startOffset": "A String", # Optional. The start offset of the video.
                         },
                       },
                     ],
-                    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
                   },
                   "score": 3.14, # The score for the given completion.
                 },
               ],
               "contents": [ # Multi-turn contents that represents the Prompt.
-                { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-                  "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                    { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                      "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+                { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+                  "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                    { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                      "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                         "outcome": "A String", # Required. Outcome of the code execution.
                         "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                       },
-                      "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                      "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                         "code": "A String", # Required. The code to be executed.
                         "language": "A String", # Required. Programming language of the `code`.
                       },
-                      "fileData": { # URI based data. # Optional. URI based data.
-                        "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                        "fileUri": "A String", # Required. URI.
+                      "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                        "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                        "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                         "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                       },
-                      "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                      "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                         "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                           "a_key": "", # Properties of the object.
                         },
                         "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                         "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                       },
-                      "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                      "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                         "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                         "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                        "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                          { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                            "fileData": { # URI based data for function response. # URI based data.
+                              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                              "fileUri": "A String", # Required. URI.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                            "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                              "data": "A String", # Required. Raw bytes.
+                              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                              "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                            },
+                          },
+                        ],
                         "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                           "a_key": "", # Properties of the object.
                         },
                       },
-                      "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                        "data": "A String", # Required. Raw bytes.
-                        "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                      "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                        "data": "A String", # Required. The raw bytes of the data.
+                        "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                         "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                       },
-                      "text": "A String", # Optional. Text part (can be code).
-                      "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                      "text": "A String", # Optional. The text content of the part.
+                      "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                       "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                      "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                      "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                         "endOffset": "A String", # Optional. The end offset of the video.
-                        "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                        "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                         "startOffset": "A String", # Optional. The start offset of the video.
                       },
                     },
                   ],
-                  "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+                  "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
                 },
               ],
             },
@@ -5492,52 +4258,66 @@ 
Method Details

           "tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset.
           "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job.
           "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri.
-            { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
-              "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-                { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+            { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.
+              "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                  "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
                     "outcome": "A String", # Required. Outcome of the code execution.
                     "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
                   },
-                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+                  "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
                     "code": "A String", # Required. The code to be executed.
                     "language": "A String", # Required. Programming language of the `code`.
                   },
-                  "fileData": { # URI based data. # Optional. URI based data.
-                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-                    "fileUri": "A String", # Required. URI.
+                  "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                    "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                    "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+                  "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
                     "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                       "a_key": "", # Properties of the object.
                     },
                     "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
                     "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
                   },
-                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+                  "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
                     "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
                     "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+                    "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                      { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                        "fileData": { # URI based data for function response. # URI based data.
+                          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "fileUri": "A String", # Required. URI.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                        "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                          "data": "A String", # Required. Raw bytes.
+                          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                      },
+                    ],
                     "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                       "a_key": "", # Properties of the object.
                     },
                   },
-                  "inlineData": { # Content blob. # Optional. Inlined bytes data.
-                    "data": "A String", # Required. Raw bytes.
-                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                  "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                    "data": "A String", # Required. The raw bytes of the data.
+                    "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
                     "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
                   },
-                  "text": "A String", # Optional. Text part (can be code).
-                  "thought": True or False, # Optional. Indicates if the part is thought from the model.
+                  "text": "A String", # Optional. The text content of the part.
+                  "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
                   "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-                  "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                  "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
                     "endOffset": "A String", # Optional. The end offset of the video.
-                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+                    "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
                     "startOffset": "A String", # Optional. The start offset of the video.
                   },
                 },
               ],
-              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
             },
           ],
           "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens.
@@ -5633,53 +4413,68 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for GenAiTuningService.OptimizePrompt.
-  "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content to optimize.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content to optimize.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
+  "optimizationTarget": "A String", # Optional. The target model to optimize the prompt for.
 }
 
   x__xgafv: string, V1 error format.
@@ -5691,52 +4486,66 @@ 
Method Details

   An object of the form:
 
     { # Response message for GenAiTuningService.OptimizePrompt
-  "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. The optimized prompt content.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The optimized prompt content.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
 }
@@ -5764,514 +4573,135 @@

Method Details

"baseModel": "A String", # The base model that is being tuned. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). "createTime": "A String", # Output only. Time when the TuningJob was created. "customBaseModel": "A String", # Optional. The user-provided path to custom model weights. Set this field to tune a custom model. The path must be a Cloud Storage directory that contains the model weights in .safetensors format along with associated model metadata files. If this field is set, the base_model field must still be set to indicate which base model the custom model is derived from. This feature is only available for open source models. - "description": "A String", # Optional. The description of the TuningJob. - "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. - "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). - "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. - "adapterSize": "A String", # Optional. Adapter size for distillation. - "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. - "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. - }, - "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. - "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. - "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. - "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. - }, - "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. - "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. - }, - "endTime": "A String", # Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. - { # Evaluate Dataset Run Result for Tuning Job. - "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. - "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. - "code": 42, # The status code, which should be an enum value of google.rpc.Code. - "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. - { - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, - ], - "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - }, - "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. - "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. - "aggregationResults": [ # One AggregationResult per metric. - { # The aggregation result for a single metric. - "aggregationMetric": "A String", # Aggregation metric. - "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. - "score": 3.14, # Output only. Bleu score. - }, - "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. - "score": 3.14, # Output only. Exact match score. - }, - "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. - "customOutput": { # Spec for custom output. # Output only. Spec for custom output. - "rawOutputs": { # Raw output. # Output only. List of raw output strings. - "rawOutput": [ # Output only. Raw output string. - "A String", - ], - }, - }, - "explanation": "A String", # Output only. Explanation for pairwise metric score. - "pairwiseChoice": "A String", # Output only. Pairwise metric choice. - }, - "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. - "customOutput": { # Spec for custom output. # Output only. Spec for custom output. - "rawOutputs": { # Raw output. # Output only. List of raw output strings. - "rawOutput": [ # Output only. Raw output string. - "A String", - ], - }, - }, - "explanation": "A String", # Output only. Explanation for pointwise metric score. - "score": 3.14, # Output only. Pointwise metric score. - }, - "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. - "score": 3.14, # Output only. Rouge score. - }, - }, - ], - "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. - "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. - "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. - }, - "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. - "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. - "A String", - ], - }, - }, - }, - "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. - "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. - }, - }, - "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. - }, - ], - "experiment": "A String", # Output only. The Experiment associated with this TuningJob. - "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. - "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. - "adapterSize": "A String", # Optional. Adapter size for tuning. - "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. - "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. - "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. - "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. - }, - "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. - "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. - }, - "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - "a_key": "A String", - }, - "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` - "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. - "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. - "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. - "a_key": "", - }, - "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. - "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. - }, - "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. - "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. - "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. - "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. - "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` - }, - "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. - "evaluationConfig": { # Evaluation Config for Tuning Job. # Optional. Evaluation Config for Preference Optimization Job. - "autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. - "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "modelConfig": { # Config for model selection. # Optional. Config for model selection. - "featureSelectionPreference": "A String", # Required. Feature selection preference. - }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. - "A String", - ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. - "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. - "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value of the data. - "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. - "A String", - ], - "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. - }, - "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - }, - "metrics": [ # Required. The metrics used for evaluation. - { # The metric used for running evaluations. - "aggregationMetrics": [ # Optional. The aggregation metrics to use. - "A String", - ], - "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. - "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. - }, - "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. - }, - "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. - "additionalConfig": { # Optional. Optional additional configuration for the metric. - "a_key": "", # Properties of the object. - }, - "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). - "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "modelConfig": { # Config for model selection. # Optional. Config for model selection. - "featureSelectionPreference": "A String", # Required. Feature selection preference. - }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. - "A String", - ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. - "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. - "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value of the data. - "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. - "A String", - ], - "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "description": "A String", # Optional. The description of the TuningJob. + "distillationSpec": { # Tuning Spec for Distillation. # Tuning Spec for Distillation. + "baseTeacherModel": "A String", # The base teacher model that is being distilled. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/tuning#supported_models). + "hyperParameters": { # Hyperparameters for Distillation. # Optional. Hyperparameters for Distillation. + "adapterSize": "A String", # Optional. Adapter size for distillation. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + }, + "pipelineRootDirectory": "A String", # Deprecated. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + "studentModel": "A String", # The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". Deprecated. Use base_model instead. + "trainingDatasetUri": "A String", # Deprecated. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. + "tunedTeacherModelSource": "A String", # The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. + }, + "encryptionSpec": { # Represents a customer-managed encryption key spec that can be applied to a top-level resource. # Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. + "kmsKeyName": "A String", # Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. The key needs to be in the same region as where the compute resource is created. + }, + "endTime": "A String", # Output only. Time when the TuningJob entered any of the following JobStates: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`, `JOB_STATE_EXPIRED`. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Only populated when job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetRuns": [ # Output only. Evaluation runs for the Tuning Job. + { # Evaluate Dataset Run Result for Tuning Job. + "checkpointId": "A String", # Output only. The checkpoint id used in the evaluation run. Only populated when evaluating checkpoints. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error of the evaluation run if any. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "evaluateDatasetResponse": { # Response in LRO for EvaluationService.EvaluateDataset. # Output only. Results for EvaluationService.EvaluateDataset. + "aggregationOutput": { # The aggregation result for the entire dataset and all metrics. # Output only. Aggregation statistics derived from results of EvaluationService.EvaluateDataset. + "aggregationResults": [ # One AggregationResult per metric. + { # The aggregation result for a single metric. + "aggregationMetric": "A String", # Aggregation metric. + "bleuMetricValue": { # Bleu metric value for an instance. # Results for bleu metric. + "score": 3.14, # Output only. Bleu score. }, - "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. - }, - "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. - "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. - "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. - "a_key": "", # Properties of the object. + "customCodeExecutionResult": { # Result for custom code execution metric. # Result for code execution metric. + "score": 3.14, # Output only. Custom code execution score. }, - }, - "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. - "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. - "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` - "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. - "modelConfig": { # Config for model selection. # Optional. Config for model selection. - "featureSelectionPreference": "A String", # Required. Feature selection preference. - }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. - "A String", - ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. - "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. - "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. - # Object with schema name: GoogleCloudAiplatformV1beta1Schema - ], - "default": "", # Optional. Default value of the data. - "defs": { # Optional. A map of definitions for use by `ref` Only allowed at the root of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "propertyOrdering": [ # Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. + "exactMatchMetricValue": { # Exact match metric value for an instance. # Results for exact match metric. + "score": 3.14, # Output only. Exact match score. + }, + "pairwiseMetricResult": { # Spec for pairwise metric result. # Result for pairwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. "A String", ], - "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring - "required": [ # Optional. Required properties of Type.OBJECT. + }, + }, + "explanation": "A String", # Output only. Explanation for pairwise metric score. + "pairwiseChoice": "A String", # Output only. Pairwise metric choice. + }, + "pointwiseMetricResult": { # Spec for pointwise metric result. # Result for pointwise metric. + "customOutput": { # Spec for custom output. # Output only. Spec for custom output. + "rawOutputs": { # Raw output. # Output only. List of raw output strings. + "rawOutput": [ # Output only. Raw output string. "A String", ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). - }, - }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, - }, - ], - }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. - }, - }, }, - "stopSequences": [ # Optional. Stop sequences. - "A String", - ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. - }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. }, - "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + "explanation": "A String", # Output only. Explanation for pointwise metric score. + "score": 3.14, # Output only. Pointwise metric score. + }, + "rougeMetricValue": { # Rouge metric value for an instance. # Results for rouge metric. + "score": 3.14, # Output only. Rouge score. }, - "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. - "rubricContentType": "A String", # The type of rubric content to be generated. - "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. - "A String", - ], - }, - "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. - "systemInstruction": "A String", # Optional. System instructions for the judge model. - }, - "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. - "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. - "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. - "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty. - "returnRawOutput": True or False, # Optional. Whether to return raw output. }, - "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric. - "systemInstruction": "A String", # Optional. System instructions for pairwise metric. - }, - "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric. - "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty. - "returnRawOutput": True or False, # Optional. Whether to return raw output. + ], + "dataset": { # The dataset used for evaluation. # The dataset used for evaluation & aggregation. + "bigquerySource": { # The BigQuery location for the input content. # BigQuery source holds the dataset. + "inputUri": "A String", # Required. BigQuery URI to a table, up to 2000 characters long. Accepted forms: * BigQuery path. For example: `bq://projectId.bqDatasetId.bqTableId`. }, - "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric. - "systemInstruction": "A String", # Optional. System instructions for pointwise metric. - }, - "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric. - "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". - "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. - "a_key": "", # Properties of the object. + "gcsSource": { # The Google Cloud Storage location for the input content. # Cloud storage source holds the dataset. Currently only one Cloud Storage file path is supported. + "uris": [ # Required. Google Cloud Storage URI(-s) to the input file(s). May contain wildcards. For more information on wildcards, see https://cloud.google.com/storage/docs/wildcards. + "A String", + ], }, }, - "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric. - "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum. - "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum. - "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score. - }, }, - ], - "outputConfig": { # Config for evaluation output. # Required. Config for evaluation output. - "gcsDestination": { # The Google Cloud Storage location where the output is to be written to. # Cloud storage destination for evaluation output. - "outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. + "outputInfo": { # Describes the info for output of EvaluationService.EvaluateDataset. # Output only. Output info for EvaluationService.EvaluateDataset. + "gcsOutputDirectory": "A String", # Output only. The full path of the Cloud Storage directory created, into which the evaluation results and aggregation results are written. }, }, + "operationName": "A String", # Output only. The operation ID of the evaluation run. Format: `projects/{project}/locations/{location}/operations/{operation_id}`. + }, + ], + "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "fullFineTuningSpec": { # Tuning Spec for Full Fine Tuning. # Tuning Spec for Full Fine Tuning. + "hyperParameters": { # Hyperparameters for SFT. # Optional. Hyperparameters for Full Fine Tuning. + "adapterSize": "A String", # Optional. Adapter size for tuning. + "batchSize": "A String", # Optional. Batch size for tuning. This feature is only available for open source models. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRate": 3.14, # Optional. Learning rate for tuning. Mutually exclusive with `learning_rate_multiplier`. This feature is only available for open source models. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. Mutually exclusive with `learning_rate`. This feature is only available for 1P models. + }, + "trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. + }, + "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. + "a_key": "A String", + }, + "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. + "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. + "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. + "a_key": "", }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. + "validationDatasetUri": "A String", # Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. + }, + "pipelineJob": "A String", # Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`. + "preTunedModel": { # A pre-tuned model for continuous tuning. # The pre-tuned model for continuous tuning. + "baseModel": "A String", # Output only. The name of the base model this PreTunedModel was tuned from. + "checkpointId": "A String", # Optional. The source checkpoint id. If not specified, the default checkpoint will be used. + "tunedModelName": "A String", # The resource name of the Model. E.g., a model resource name with a specified version id or alias: `projects/{project}/locations/{location}/models/{model}@{version_id}` `projects/{project}/locations/{location}/models/{model}@{alias}` Or, omit the version id to use the default version: `projects/{project}/locations/{location}/models/{model}` + }, + "preferenceOptimizationSpec": { # Tuning Spec for Preference Optimization. # Tuning Spec for Preference Optimization. "exportLastCheckpointOnly": True or False, # Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false. "hyperParameters": { # Hyperparameters for Preference Optimization. # Optional. Hyperparameters for Preference Optimization. "adapterSize": "A String", # Optional. Adapter size for preference optimization. @@ -6292,28 +4722,33 @@

Method Details

"autoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Autorater config for evaluation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -6352,45 +4787,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6402,6 +4837,9 @@

Method Details

"bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric. "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score. }, + "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric. + "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` + }, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. @@ -6411,28 +4849,33 @@

Method Details

"judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -6471,45 +4914,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6524,28 +4967,33 @@

Method Details

"modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. - "generationConfig": { # Generation config. # Optional. Configuration options for model generation and outputs. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -6584,45 +5032,45 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, @@ -6709,52 +5157,66 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Distribution computed over a tuning dataset. # Output only. Dataset distributions for the user input tokens. @@ -6853,103 +5315,131 @@

Method Details

{ # Input example for preference optimization. "completions": [ # List of completions for a given prompt. { # Completion and its preference score. - "completion": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Single turn completion for the given prompt. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "completion": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Single turn completion for the given prompt. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "score": 3.14, # The score for the given completion. }, ], "contents": [ # Multi-turn contents that represents the Prompt. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], }, @@ -7001,52 +5491,66 @@

Method Details

"tuningDatasetExampleCount": "A String", # Output only. Number of examples in the tuning dataset. "tuningStepCount": "A String", # Output only. Number of tuning steps for this Tuning Job. "userDatasetExamples": [ # Output only. Sample user messages in the training dataset uri. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "userInputTokenDistribution": { # Dataset distribution for Supervised Tuning. # Output only. Dataset distributions for the user input tokens. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 07105cac91..de357a6663 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -124,52 +124,66 @@

Method Details

{ # Request message for ComputeTokens RPC call. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. @@ -212,76 +226,95 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -320,101 +353,121 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -628,9 +681,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -692,76 +745,95 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -800,106 +872,120 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -920,6 +1006,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -1134,184 +1226,198 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -1323,46 +1429,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -1599,7 +1705,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -1791,7 +1897,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -2213,7 +2319,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -2405,7 +2511,7 @@

Method Details

"minReplicaCount": 42, # Required. Immutable. The minimum number of machine replicas that will be always deployed on. This value must be greater than or equal to 1. If traffic increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. "requiredReplicaCount": 42, # Optional. Number of required available replicas for the deployment to succeed. This field is only needed when partial deployment/mutation is desired. If set, the deploy/mutate operation will succeed once available_replica_count reaches required_replica_count, and the rest of the replicas will be retried. If not set, the default required_replica_count will be min_replica_count. "scaleToZeroSpec": { # Specification for scale-to-zero feature. # Optional. Specification for scale-to-zero feature. - "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours) + "idleScaledownPeriod": "A String", # Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) "minScaleupPeriod": "A String", # Optional. Minimum duration that a deployment will be scaled up before traffic is evaluated for potential scale-down. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours) }, "spot": True or False, # Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). @@ -2623,6 +2729,9 @@

Method Details

"instances": [ # Required. The instances that are the input to the prediction call. A DeployedModel may have an upper limit on the number of instances it supports per request, and when it is exceeded the prediction call errors in case of AutoML Models, or, in case of customer created Models, the behaviour is as documented by that Model. The schema of any single instance may be specified via Endpoint's DeployedModels' Model's PredictSchemata's instance_schema_uri. "", ], + "labels": { # Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored. + "a_key": "A String", + }, "parameters": "", # The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri. } @@ -2703,76 +2812,95 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -2811,106 +2939,120 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -2931,6 +3073,12 @@

Method Details

{ # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also [ExecutableCode]and [CodeExecutionResult] which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. @@ -3145,184 +3293,198 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -3334,46 +3496,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. diff --git a/docs/dyn/aiplatform_v1beta1.ragCorpora.html b/docs/dyn/aiplatform_v1beta1.ragCorpora.html new file mode 100644 index 0000000000..4d59026381 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.ragCorpora.html @@ -0,0 +1,96 @@ + + + +

Vertex AI API . ragCorpora

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ ragFiles() +

+

Returns the ragFiles Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.ragCorpora.operations.html b/docs/dyn/aiplatform_v1beta1.ragCorpora.operations.html new file mode 100644 index 0000000000..ad3ef3842b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.ragCorpora.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . ragCorpora . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.html new file mode 100644 index 0000000000..14eb67d593 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . ragCorpora . ragFiles

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.operations.html b/docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.operations.html new file mode 100644 index 0000000000..155aacdd2a --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.ragCorpora.ragFiles.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . ragCorpora . ragFiles . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.ragEngineConfig.html b/docs/dyn/aiplatform_v1beta1.ragEngineConfig.html new file mode 100644 index 0000000000..bc26d8d3e2 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.ragEngineConfig.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . ragEngineConfig

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.ragEngineConfig.operations.html b/docs/dyn/aiplatform_v1beta1.ragEngineConfig.operations.html new file mode 100644 index 0000000000..fb8a255170 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.ragEngineConfig.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . ragEngineConfig . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.html new file mode 100644 index 0000000000..5aaf68aa50 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . reasoningEngines . examples

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.operations.html new file mode 100644 index 0000000000..3d96a85cb9 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.examples.operations.html @@ -0,0 +1,205 @@ + + + +

Vertex AI API . reasoningEngines . examples . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 08af9dbd6e..7046017fa2 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -79,11 +79,26 @@

Instance Methods

Returns the a2a Resource.

+

+ examples() +

+

Returns the examples Resource.

+

memories()

Returns the memories Resource.

+

+ operations() +

+

Returns the operations Resource.

+ +

+ sandboxEnvironments() +

+

Returns the sandboxEnvironments Resource.

+

sessions()

@@ -140,52 +155,66 @@

Method Details

"conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. "events": [ # Optional. The input conversation events for the example. { # A single conversation event. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -219,6 +248,7 @@

Method Details

], }, ], + "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, @@ -232,6 +262,7 @@

Method Details

"generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL). }, + "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used. }, }, }, @@ -247,6 +278,9 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine + "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. + "a_key": "", # Properties of the object. + }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { @@ -290,10 +324,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -388,52 +433,66 @@

Method Details

"conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. "events": [ # Optional. The input conversation events for the example. { # A single conversation event. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -467,6 +526,7 @@

Method Details

], }, ], + "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, @@ -480,6 +540,7 @@

Method Details

"generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL). }, + "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used. }, }, }, @@ -495,6 +556,9 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine + "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. + "a_key": "", # Properties of the object. + }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { @@ -538,10 +602,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } @@ -577,52 +652,66 @@

Method Details

"conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. "events": [ # Optional. The input conversation events for the example. { # A single conversation event. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -656,6 +745,7 @@

Method Details

], }, ], + "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, @@ -669,6 +759,7 @@

Method Details

"generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL). }, + "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used. }, }, }, @@ -684,6 +775,9 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine + "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. + "a_key": "", # Properties of the object. + }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { @@ -727,10 +821,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. }, @@ -771,52 +876,66 @@

Method Details

"conversationSource": { # A conversation source for the example. This is similar to `DirectContentsSource`. # A conversation source for the example. "events": [ # Optional. The input conversation events for the example. { # A single conversation event. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. The content of the event. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -850,6 +969,7 @@

Method Details

], }, ], + "disableMemoryRevisions": True or False, # If true, no memory revisions will be created for any requests to the Memory Bank. "generationConfig": { # Configuration for how to generate memories. # Optional. Configuration for how to generate memories for the Memory Bank. "model": "A String", # Required. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. }, @@ -863,6 +983,7 @@

Method Details

"generateCreatedTtl": "A String", # Optional. The TTL duration for memories newly generated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.CREATED). "generateUpdatedTtl": "A String", # Optional. The TTL duration for memories updated via GenerateMemories (GenerateMemoriesResponse.GeneratedMemory.Action.UPDATED). In the case of an UPDATE action, the `expire_time` of the existing memory will be updated to the new value (now + TTL). }, + "memoryRevisionDefaultTtl": "A String", # Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used. }, }, }, @@ -878,6 +999,9 @@

Method Details

}, "name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine + "agentCard": { # Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card. + "a_key": "", # Properties of the object. + }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { @@ -921,10 +1045,21 @@

Method Details

"packageSpec": { # User-provided package specification, containing pickled object and package requirements. # Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through `deployment_spec.first_party_image_override`, but keeping the field_behavior to avoid introducing breaking changes. The `deployment_source` field should not be set if `package_spec` is specified. "dependencyFilesGcsUri": "A String", # Optional. The Cloud Storage URI of the dependency files in tar.gz format. "pickleObjectGcsUri": "A String", # Optional. The Cloud Storage URI of the pickled python object. - "pythonVersion": "A String", # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10. + "pythonVersion": "A String", # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10. "requirementsGcsUri": "A String", # Optional. The Cloud Storage URI of the `requirements.txt` file }, "serviceAccount": "A String", # Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used. + "sourceCodeSpec": { # Specification for deploying from source code. # Deploy from source code files with a defined entrypoint. + "inlineSource": { # Specifies source code provided as a byte stream. # Source code is provided directly in the request. + "sourceArchive": "A String", # Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file. + }, + "pythonSpec": { # Specification for running a Python application from source. # Configuration for a Python application. + "entrypointModule": "A String", # Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to "agent". The project root will be added to Python sys.path, allowing imports to be specified relative to the root. + "entrypointObject": "A String", # Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to "root_agent". + "requirementsFile": "A String", # Optional. The path to the requirements file, relative to the source root. If not specified, defaults to "requirements.txt". + "version": "A String", # Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10. + }, + }, }, "updateTime": "A String", # Output only. Timestamp when this ReasoningEngine was most recently updated. } diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index 58c00d6551..ec671ca3e6 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -74,6 +74,16 @@

Vertex AI API . reasoningEngines . memories

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ revisions() +

+

Returns the revisions Resource.

+

close()

Close httplib2 connections.

@@ -101,6 +111,9 @@

Instance Methods

retrieve(parent, body=None, x__xgafv=None)

Retrieve memories.

+

+ rollback(name, body=None, x__xgafv=None)

+

Rollback Memory to a specific revision.

Method Details

close() @@ -119,13 +132,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } @@ -207,52 +232,66 @@

Method Details

"directContentsSource": { # Defines a direct source of content from which to generate the memories. # Defines a direct source of content as the source content from which to generate memories. "events": [ # Required. The source content (i.e. chat history) to generate memories from. { # A single piece of conversation from which to generate memories. - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Required. A single piece of content from which to generate memories. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. A single piece of content from which to generate memories. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. "a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, ], @@ -261,10 +300,22 @@

Method Details

"directMemories": [ # Required. The direct memories to upload to Memory Bank. At most 5 direct memories are allowed per request. { # A direct memory to upload to Memory Bank. "fact": "A String", # Required. The fact to consolidate with existing memories. + "topics": [ # Optional. The topics that the consolidated memories should be associated with. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, "disableConsolidation": True or False, # Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled. + "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. + "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, @@ -321,13 +372,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } @@ -356,13 +419,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. }, @@ -397,13 +472,25 @@

Method Details

{ # A memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. } @@ -448,6 +535,7 @@

Method Details

The object takes the form of: { # Request message for MemoryBankService.RetrieveMemories. + "filter": "A String", # Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time` "scope": { # Required. The scope of the memories to retrieve. A memory must have exactly the same scope (`Memory.scope`) as the scope provided here to be retrieved (same keys and values). Order does not matter, but it is case-sensitive. "a_key": "A String", }, @@ -477,13 +565,25 @@

Method Details

"memory": { # A memory. # The retrieved Memory. "createTime": "A String", # Output only. Timestamp when this Memory was created. "description": "A String", # Optional. Description of the Memory. + "disableMemoryRevisions": True or False, # Optional. Input only. If true, no revision will be created for this request. "displayName": "A String", # Optional. Display name of the Memory. "expireTime": "A String", # Optional. Timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided. "fact": "A String", # Required. Semantic knowledge extracted from the source content. "name": "A String", # Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` + "revisionExpireTime": "A String", # Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Input only. The labels to apply to the Memory Revision created as a result of this request. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "topics": [ # Optional. The Topics of the Memory. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], "ttl": "A String", # Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL. "updateTime": "A String", # Output only. Timestamp when this Memory was most recently updated. }, @@ -492,4 +592,46 @@

Method Details

}
+
+ rollback(name, body=None, x__xgafv=None) + 
Rollback Memory to a specific revision.
+
+Args:
+  name: string, Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for MemoryBankService.RollbackMemory.
+  "targetRevisionId": "A String", # Required. The ID of the revision to rollback to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.operations.html new file mode 100644 index 0000000000..a2f10ce38b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . memories . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html new file mode 100644 index 0000000000..203b24c2b3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.revisions.html @@ -0,0 +1,177 @@ + + + +

Vertex AI API . reasoningEngines . memories . revisions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory Revision.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

List Memory Revisions for a Memory.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) + 
Get a Memory Revision.
+
+Args:
+  name: string, Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A revision of a Memory.
+  "createTime": "A String", # Output only. Timestamp when this Memory Revision was created.
+  "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired.
+  "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+    { # An extracted memory that is the intermediate result before consolidation.
+      "fact": "A String", # Output only. The fact of the extracted memory.
+    },
+  ],
+  "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+  "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + 
List Memory Revisions for a Memory.
+
+Args:
+  parent: string, Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for MemoryBankService.ListMemoryRevisions.
+  "memoryRevisions": [ # The list of Memory Revisions in the request page.
+    { # A revision of a Memory.
+      "createTime": "A String", # Output only. Timestamp when this Memory Revision was created.
+      "expireTime": "A String", # Output only. Timestamp of when this resource is considered expired.
+      "extractedMemories": [ # Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.
+        { # An extracted memory that is the intermediate result before consolidation.
+          "fact": "A String", # Output only. The fact of the extracted memory.
+        },
+      ],
+      "fact": "A String", # Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.
+      "labels": { # Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.operations.html new file mode 100644 index 0000000000..30a9180cbd --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html new file mode 100644 index 0000000000..387dfd57d0 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.html @@ -0,0 +1,349 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironments

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a SandboxEnvironment in a given reasoning engine.

+

+ delete(name, x__xgafv=None)

+

Deletes the specific SandboxEnvironment.

+

+ execute(name, body=None, x__xgafv=None)

+

Executes using a sandbox environment.

+

+ get(name, x__xgafv=None)

+

Gets details of the specific SandboxEnvironment.

+

+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists SandboxEnvironments in a given reasoning engine.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a SandboxEnvironment in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
+  "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
+    "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
+    "loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+    "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
+  },
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironment.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The name of the SandboxEnvironment.
+  "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
+    "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
+      "codeLanguage": "A String", # The coding language supported in this environment.
+      "machineConfig": "A String", # The machine config of the code execution environment.
+    },
+    "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment.
+    },
+  },
+  "state": "A String", # Output only. The runtime state of the SandboxEnvironment.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes the specific SandboxEnvironment.
+
+Args:
+  name: string, Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ execute(name, body=None, x__xgafv=None) + 
Executes using a sandbox environment.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SandboxEnvironmentExecutionService.Execute.
+  "inputs": [ # Required. The inputs to the sandbox environment.
+    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
+      "data": "A String", # Required. The data in the chunk.
+      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
+        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
+          "a_key": "A String",
+        },
+      },
+      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SandboxEnvironmentExecutionService.Execute.
+  "outputs": [ # The outputs from the sandbox environment.
+    { # Container for bytes-encoded data such as video frame, audio sample, or a complete binary/text data.
+      "data": "A String", # Required. The data in the chunk.
+      "metadata": { # Metadata for a chunk. # Optional. Metadata that is associated with the data in the payload.
+        "attributes": { # Optional. Attributes attached to the data. The keys have semantic conventions and the consumers of the attributes should know how to deserialize the value bytes based on the keys.
+          "a_key": "A String",
+        },
+      },
+      "mimeType": "A String", # Required. Mime type of the chunk data. See https://www.iana.org/assignments/media-types/media-types.xhtml for the full list.
+    },
+  ],
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets details of the specific SandboxEnvironment.
+
+Args:
+  name: string, Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
+  "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
+    "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
+    "loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+    "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
+  },
+  "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
+  "displayName": "A String", # Required. The display name of the SandboxEnvironment.
+  "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+  "name": "A String", # Identifier. The name of the SandboxEnvironment.
+  "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
+    "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
+      "codeLanguage": "A String", # The coding language supported in this environment.
+      "machineConfig": "A String", # The machine config of the code execution environment.
+    },
+    "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment.
+    },
+  },
+  "state": "A String", # Output only. The runtime state of the SandboxEnvironment.
+  "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists SandboxEnvironments in a given reasoning engine.
+
+Args:
+  parent: string, Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  filter: string, Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).
+  pageSize: integer, Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.
+  pageToken: string, Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for SandboxEnvironmentService.ListSandboxEnvironments.
+  "nextPageToken": "A String", # A token, which can be sent as ListSandboxEnvironmentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
+  "sandboxEnvironments": [ # The SandboxEnvironments matching the request.
+    { # SandboxEnvironment is a containerized environment that provides a customizable secure execution runtime for AI agents.
+      "connectionInfo": { # The connection information of the SandboxEnvironment. # Output only. The connection information of the SandboxEnvironment.
+        "loadBalancerHostname": "A String", # Output only. The hostname of the load balancer.
+        "loadBalancerIp": "A String", # Output only. The IP address of the load balancer.
+        "sandboxInternalIp": "A String", # Output only. The internal IP address of the SandboxEnvironment.
+      },
+      "createTime": "A String", # Output only. The timestamp when this SandboxEnvironment was created.
+      "displayName": "A String", # Required. The display name of the SandboxEnvironment.
+      "expireTime": "A String", # Optional. Timestamp in UTC of when this SandboxEnvironment is considered expired. This is *always* provided on output, regardless of what `expiration` was sent on input.
+      "name": "A String", # Identifier. The name of the SandboxEnvironment.
+      "spec": { # The specification of a SandboxEnvironment. # Optional. The configuration of the SandboxEnvironment.
+        "codeExecutionEnvironment": { # The code execution environment with customized settings. # Optional. The code execution environment.
+          "codeLanguage": "A String", # The coding language supported in this environment.
+          "machineConfig": "A String", # The machine config of the code execution environment.
+        },
+        "computerUseEnvironment": { # The computer use environment with customized settings. # Optional. The computer use environment.
+        },
+      },
+      "state": "A String", # Output only. The runtime state of the SandboxEnvironment.
+      "ttl": "A String", # Optional. Input only. The TTL for the sandbox environment. The expiration time is computed: now + TTL.
+      "updateTime": "A String", # Output only. The timestamp when this SandboxEnvironment was most recently updated.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.operations.html new file mode 100644 index 0000000000..91a7c019c3 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironments.operations.html @@ -0,0 +1,272 @@ + + + +

Vertex AI API . reasoningEngines . sandboxEnvironments . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) + 
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) + 
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) + 
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) + 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ wait(name, timeout=None, x__xgafv=None) + 
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 6cd8d6ca04..2954e32407 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists Events in a given session.

list_next()

@@ -90,12 +90,13 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) 
Lists Events in a given session.
 
 Args:
   parent: string, Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
   filter: string, Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.
   pageSize: integer, Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.
   pageToken: string, Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.
   x__xgafv: string, V1 error format.
@@ -123,55 +124,68 @@ 
Method Details

           "a_key": "", # Properties of the object.
         },
         "transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
-        "transferToAgent": True or False, # Deprecated. If set, the event transfers to the specified agent.
       },
       "author": "A String", # Required. The name of the agent that sent the event, or user.
-      "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Content of the event provided by the author.
-        "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-          { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+      "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author.
+        "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+          { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+            "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
               "outcome": "A String", # Required. Outcome of the code execution.
               "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
             },
-            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+            "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
               "code": "A String", # Required. The code to be executed.
               "language": "A String", # Required. Programming language of the `code`.
             },
-            "fileData": { # URI based data. # Optional. URI based data.
-              "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-              "fileUri": "A String", # Required. URI.
+            "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+              "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+              "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+            "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
               "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
                 "a_key": "", # Properties of the object.
               },
               "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
               "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
             },
-            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+            "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
               "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
               "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+              "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                  "fileData": { # URI based data for function response. # URI based data.
+                    "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "fileUri": "A String", # Required. URI.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                  "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                    "data": "A String", # Required. Raw bytes.
+                    "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                    "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                  },
+                },
+              ],
               "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
                 "a_key": "", # Properties of the object.
               },
             },
-            "inlineData": { # Content blob. # Optional. Inlined bytes data.
-              "data": "A String", # Required. Raw bytes.
-              "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+            "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+              "data": "A String", # Required. The raw bytes of the data.
+              "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
               "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
             },
-            "text": "A String", # Optional. Text part (can be code).
-            "thought": True or False, # Optional. Indicates if the part is thought from the model.
+            "text": "A String", # Optional. The text content of the part.
+            "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
             "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-            "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+            "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
               "endOffset": "A String", # Optional. The end offset of the video.
-              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+              "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
               "startOffset": "A String", # Optional. The start offset of the video.
             },
           },
         ],
-        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+        "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
       },
       "errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
       "errorMessage": "A String", # Optional. Error message if the response is an error.
@@ -180,78 +194,78 @@ 
Method Details

         "customMetadata": { # The custom metadata of the LlmResponse.
           "a_key": "", # Properties of the object.
         },
-        "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Optional. Metadata returned to client when grounding is enabled.
-          "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-          "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-            { # Grounding chunk.
-              "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-                "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                    { # Encapsulates a review snippet.
+        "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Optional. Metadata returned to client when grounding is enabled.
+          "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+          "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+            { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+              "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+                "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+                  "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                    { # A review snippet that is used to generate the answer.
                       "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                      "reviewId": "A String", # Id of the review referencing the place.
-                      "title": "A String", # Title of the review.
+                      "reviewId": "A String", # The ID of the review that is being referenced.
+                      "title": "A String", # The title of the review.
                     },
                   ],
                 },
-                "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-                "text": "A String", # Text of the place answer.
-                "title": "A String", # Title of the place.
-                "uri": "A String", # URI reference of the place.
+                "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+                "text": "A String", # The text of the place answer.
+                "title": "A String", # The title of the place.
+                "uri": "A String", # The URI of the place.
               },
-              "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-                "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-                "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+              "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+                "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+                "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
                   "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                     "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                     "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
                   },
                   "text": "A String", # The content of the chunk.
                 },
-                "text": "A String", # Text of the attribution.
-                "title": "A String", # Title of the attribution.
-                "uri": "A String", # URI reference of the attribution.
+                "text": "A String", # The content of the retrieved data source.
+                "title": "A String", # The title of the retrieved data source.
+                "uri": "A String", # The URI of the retrieved data source.
               },
-              "web": { # Chunk from the web. # Grounding chunk from the web.
-                "domain": "A String", # Domain of the (original) URI.
-                "title": "A String", # Title of the chunk.
-                "uri": "A String", # URI reference of the chunk.
+              "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+                "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+                "title": "A String", # The title of the web page that contains the evidence.
+                "uri": "A String", # The URI of the web page that contains the evidence.
               },
             },
           ],
-          "groundingSupports": [ # Optional. List of grounding support.
-            { # Grounding support.
-              "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+          "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+            { # A collection of supporting references for a segment of the model's response.
+              "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
                 3.14,
               ],
-              "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+              "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
                 42,
               ],
-              "segment": { # Segment of the content. # Segment of the content this support belongs to.
-                "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-                "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-                "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-                "text": "A String", # Output only. The text corresponding to the segment from the response.
+              "segment": { # A segment of the content. # The content segment that this support message applies to.
+                "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+                "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+                "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+                "text": "A String", # Output only. The text of the segment.
               },
             },
           ],
-          "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-            "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+          "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+            "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
           },
-          "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+          "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
             "A String",
           ],
-          "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-            "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-            "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+          "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+            "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+            "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
           },
-          "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-            { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-              "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-              "sourceId": "A String", # Id of the place or review.
+          "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+            { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+              "flagContentUri": "A String", # The URI that can be used to flag the content.
+              "sourceId": "A String", # The ID of the place or review.
             },
           ],
-          "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+          "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
             "A String",
           ],
         },
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
index b62e6dc9f7..ca8bd0a57a 100644
--- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html
@@ -79,6 +79,11 @@ 
Instance Methods

 

 
Returns the events Resource.

 
+

+  operations()
+

+
Returns the operations Resource.

+
 

   appendEvent(name, body=None, x__xgafv=None)

 
Appends an event to a given session.

@@ -127,55 +132,68 @@ 
Method Details

       "a_key": "", # Properties of the object.
     },
     "transferAgent": "A String", # Optional. If set, the event transfers to the specified agent.
-    "transferToAgent": True or False, # Deprecated. If set, the event transfers to the specified agent.
   },
   "author": "A String", # Required. The name of the agent that sent the event, or user.
-  "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. Content of the event provided by the author.
-    "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
-      { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
-        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode].
+  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. Content of the event provided by the author.
+    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+        "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode.
           "outcome": "A String", # Required. Outcome of the code execution.
           "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
         },
-        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed.
+        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed.
           "code": "A String", # Required. The code to be executed.
           "language": "A String", # Required. Programming language of the `code`.
         },
-        "fileData": { # URI based data. # Optional. URI based data.
-          "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
-          "fileUri": "A String", # Required. URI.
+        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
+        "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
           "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.
             "a_key": "", # Properties of the object.
           },
           "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.
           "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name].
         },
-        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.
+        "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
           "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.
           "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].
+          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+              "fileData": { # URI based data for function response. # URI based data.
+                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "fileUri": "A String", # Required. URI.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                "data": "A String", # Required. Raw bytes.
+                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+              },
+            },
+          ],
           "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
             "a_key": "", # Properties of the object.
           },
         },
-        "inlineData": { # Content blob. # Optional. Inlined bytes data.
-          "data": "A String", # Required. Raw bytes.
-          "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+          "data": "A String", # Required. The raw bytes of the data.
+          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
           "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
         },
-        "text": "A String", # Optional. Text part (can be code).
-        "thought": True or False, # Optional. Indicates if the part is thought from the model.
+        "text": "A String", # Optional. The text content of the part.
+        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
         "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
-        "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
           "endOffset": "A String", # Optional. The end offset of the video.
-          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].
+          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
           "startOffset": "A String", # Optional. The start offset of the video.
         },
       },
     ],
-    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.
+    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
   },
   "errorCode": "A String", # Optional. Error code if the response is an error. Code varies by model.
   "errorMessage": "A String", # Optional. Error message if the response is an error.
@@ -184,78 +202,78 @@ 
Method Details

     "customMetadata": { # The custom metadata of the LlmResponse.
       "a_key": "", # Properties of the object.
     },
-    "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Optional. Metadata returned to client when grounding is enabled.
-      "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
-      "groundingChunks": [ # List of supporting references retrieved from specified grounding source.
-        { # Grounding chunk.
-          "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps.
-            "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content.
-              "reviewSnippets": [ # Snippets of reviews that are used to generate the answer.
-                { # Encapsulates a review snippet.
+    "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Optional. Metadata returned to client when grounding is enabled.
+      "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
+      "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
+        { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+          "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
+            "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
+              "reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
+                { # A review snippet that is used to generate the answer.
                   "googleMapsUri": "A String", # A link to show the review on Google Maps.
-                  "reviewId": "A String", # Id of the review referencing the place.
-                  "title": "A String", # Title of the review.
+                  "reviewId": "A String", # The ID of the review that is being referenced.
+                  "title": "A String", # The title of the review.
                 },
               ],
             },
-            "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.
-            "text": "A String", # Text of the place answer.
-            "title": "A String", # Title of the place.
-            "uri": "A String", # URI reference of the place.
+            "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+            "text": "A String", # The text of the place answer.
+            "title": "A String", # The title of the place.
+            "uri": "A String", # The URI of the place.
           },
-          "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools.
-            "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document.
-            "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool.
+          "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details
+            "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
+            "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.
               "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document.
                 "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed.
                 "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed.
               },
               "text": "A String", # The content of the chunk.
             },
-            "text": "A String", # Text of the attribution.
-            "title": "A String", # Title of the attribution.
-            "uri": "A String", # URI reference of the attribution.
+            "text": "A String", # The content of the retrieved data source.
+            "title": "A String", # The title of the retrieved data source.
+            "uri": "A String", # The URI of the retrieved data source.
           },
-          "web": { # Chunk from the web. # Grounding chunk from the web.
-            "domain": "A String", # Domain of the (original) URI.
-            "title": "A String", # Title of the chunk.
-            "uri": "A String", # URI reference of the chunk.
+          "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details.
+            "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.
+            "title": "A String", # The title of the web page that contains the evidence.
+            "uri": "A String", # The URI of the web page that contains the evidence.
           },
         },
       ],
-      "groundingSupports": [ # Optional. List of grounding support.
-        { # Grounding support.
-          "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.
+      "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
+        { # A collection of supporting references for a segment of the model's response.
+          "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
             3.14,
           ],
-          "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.
+          "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
             42,
           ],
-          "segment": { # Segment of the content. # Segment of the content this support belongs to.
-            "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.
-            "partIndex": 42, # Output only. The index of a Part object within its parent Content object.
-            "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.
-            "text": "A String", # Output only. The text corresponding to the segment from the response.
+          "segment": { # A segment of the content. # The content segment that this support message applies to.
+            "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
+            "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
+            "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.
+            "text": "A String", # Output only. The text of the segment.
           },
         },
       ],
-      "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata.
-        "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.
+      "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
+        "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
       },
-      "retrievalQueries": [ # Optional. Queries executed by the retrieval tools.
+      "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.
         "A String",
       ],
-      "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches.
-        "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview.
-        "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple.
+      "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.
+        "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.
+        "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.
       },
-      "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.
-        { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.
-          "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review).
-          "sourceId": "A String", # Id of the place or review.
+      "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.
+        { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.
+          "flagContentUri": "A String", # The URI that can be used to flag the content.
+          "sourceId": "A String", # The ID of the place or review.
         },
       ],
-      "webSearchQueries": [ # Optional. Web search queries for the following-up web search.
+      "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.
         "A String",
       ],
     },
@@ -408,7 +426,7 @@ 
Method Details

 
 Args:
   parent: string, Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
-  filter: string, Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.
+  filter: string, Optional. The standard list filter. Supported fields: * `display_name` * `user_id` Example: `display_name="abc"`, `user_id="123"`.
   orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
   pageSize: integer, Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.
   pageToken: string, Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.operations.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.operations.html
new file mode 100644
index 0000000000..477c26a3be
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . reasoningEngines . sessions . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.schedules.html b/docs/dyn/aiplatform_v1beta1.schedules.html
new file mode 100644
index 0000000000..81f9a90cc8
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.schedules.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . schedules

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.schedules.operations.html b/docs/dyn/aiplatform_v1beta1.schedules.operations.html
new file mode 100644
index 0000000000..ffb48b6f8d
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.schedules.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . schedules . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.solvers.html b/docs/dyn/aiplatform_v1beta1.solvers.html
new file mode 100644
index 0000000000..b9a90829f0
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.solvers.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . solvers

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.solvers.operations.html b/docs/dyn/aiplatform_v1beta1.solvers.operations.html
new file mode 100644
index 0000000000..9ca0edf01d
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.solvers.operations.html
@@ -0,0 +1,212 @@
+
+
+
+
Vertex AI API . solvers . operations

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.specialistPools.html b/docs/dyn/aiplatform_v1beta1.specialistPools.html
new file mode 100644
index 0000000000..5eed687ebf
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.specialistPools.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . specialistPools

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.specialistPools.operations.html b/docs/dyn/aiplatform_v1beta1.specialistPools.operations.html
new file mode 100644
index 0000000000..02d4aae395
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.specialistPools.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . specialistPools . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.studies.html b/docs/dyn/aiplatform_v1beta1.studies.html
new file mode 100644
index 0000000000..555b0bae58
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.studies.html
@@ -0,0 +1,96 @@
+
+
+
+
Vertex AI API . studies

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  trials()
+

+
Returns the trials Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.studies.operations.html b/docs/dyn/aiplatform_v1beta1.studies.operations.html
new file mode 100644
index 0000000000..2738106f44
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.studies.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . studies . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.studies.trials.html b/docs/dyn/aiplatform_v1beta1.studies.trials.html
new file mode 100644
index 0000000000..eb29954dcb
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.studies.trials.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . studies . trials

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.studies.trials.operations.html b/docs/dyn/aiplatform_v1beta1.studies.trials.operations.html
new file mode 100644
index 0000000000..cdc63ca951
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.studies.trials.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . studies . trials . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.html b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.html
new file mode 100644
index 0000000000..45d70ab2a8
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.html
@@ -0,0 +1,96 @@
+
+
+
+
Vertex AI API . tensorboards . experiments

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  runs()
+

+
Returns the runs Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.operations.html b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.operations.html
new file mode 100644
index 0000000000..6730b8e1f0
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . tensorboards . experiments . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.html b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.html
new file mode 100644
index 0000000000..a57289a8cc
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.html
@@ -0,0 +1,96 @@
+
+
+
+
Vertex AI API . tensorboards . experiments . runs

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  timeSeries()
+

+
Returns the timeSeries Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.operations.html b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.operations.html
new file mode 100644
index 0000000000..268bb844ba
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . tensorboards . experiments . runs . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.html b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.html
new file mode 100644
index 0000000000..b3ea7d2673
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . tensorboards . experiments . runs . timeSeries

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.operations.html b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.operations.html
new file mode 100644
index 0000000000..3007ea270a
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.experiments.runs.timeSeries.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . tensorboards . experiments . runs . timeSeries . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.html b/docs/dyn/aiplatform_v1beta1.tensorboards.html
new file mode 100644
index 0000000000..144a0b2ded
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.html
@@ -0,0 +1,96 @@
+
+
+
+
Vertex AI API . tensorboards

+
Instance Methods

+

+  experiments()
+

+
Returns the experiments Resource.

+
+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tensorboards.operations.html b/docs/dyn/aiplatform_v1beta1.tensorboards.operations.html
new file mode 100644
index 0000000000..826e851a7f
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tensorboards.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . tensorboards . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.trainingPipelines.html b/docs/dyn/aiplatform_v1beta1.trainingPipelines.html
new file mode 100644
index 0000000000..e037ad0435
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.trainingPipelines.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . trainingPipelines

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.trainingPipelines.operations.html b/docs/dyn/aiplatform_v1beta1.trainingPipelines.operations.html
new file mode 100644
index 0000000000..10aa37a7a9
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.trainingPipelines.operations.html
@@ -0,0 +1,272 @@
+
+
+
+
Vertex AI API . trainingPipelines . operations

+
Instance Methods

+

+  cancel(name, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+

+  wait(name, timeout=None, x__xgafv=None)

+
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+
Method Details

+

+    cancel(name, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    wait(name, timeout=None, x__xgafv=None)
+  
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.tuningJobs.html
new file mode 100644
index 0000000000..3aca5c17f5
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tuningJobs.html
@@ -0,0 +1,91 @@
+
+
+
+
Vertex AI API . tuningJobs

+
Instance Methods

+

+  operations()
+

+
Returns the operations Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html b/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html
new file mode 100644
index 0000000000..d03e372ccc
--- /dev/null
+++ b/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html
@@ -0,0 +1,107 @@
+
+
+
+
Vertex AI API . tuningJobs . operations

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
index 727e53c735..bb3feca015 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json
@@ -106,6 +106,11 @@
 },
 {
 "description": "Locational Endpoint",
+"endpointUrl": "https://europe-west15-aiplatform.googleapis.com/",
+"location": "europe-west15"
+},
+{
+"description": "Locational Endpoint",
 "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/",
 "location": "europe-west2"
 },
@@ -431,6 +436,326 @@
 }
 }
 },
+"customJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.customJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.customJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.customJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/customJobs/{customJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.customJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^customJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/customJobs/{customJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.customJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"dataLabelingJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.dataLabelingJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.dataLabelingJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.dataLabelingJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.dataLabelingJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^dataLabelingJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.dataLabelingJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
 "datasets": {
 "methods": {
 "create": {
@@ -597,539 +922,475 @@
 }
 },
 "resources": {
-"datasetVersions": {
+"annotationSpecs": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Create a version from a Dataset.",
-"flatPath": "v1/datasets/{datasetsId}/datasetVersions",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.datasets.datasetVersions.create",
+"id": "aiplatform.datasets.annotationSpecs.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^datasets/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/datasetVersions",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a Dataset version.",
-"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"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/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.datasets.datasetVersions.delete",
+"id": "aiplatform.datasets.annotationSpecs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Dataset version.",
-"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"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/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.datasets.datasetVersions.get",
+"id": "aiplatform.datasets.annotationSpecs.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists DatasetVersions in a Dataset.",
-"flatPath": "v1/datasets/{datasetsId}/datasetVersions",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.datasets.datasetVersions.list",
+"id": "aiplatform.datasets.annotationSpecs.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^datasets/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/datasetVersions",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a DatasetVersion.",
-"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.datasets.datasetVersions.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.datasets.annotationSpecs.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
-},
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"restore": {
-"description": "Restores a dataset version.",
-"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
-"httpMethod": "GET",
-"id": "aiplatform.datasets.datasetVersions.restore",
+"dataItems": {
+"resources": {
+"annotations": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.datasets.dataItems.annotations.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:restore",
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"endpoints": {
-"methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1/endpoints/{endpointsId}:computeTokens",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.computeTokens",
+"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/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.dataItems.annotations.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:computeTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1/endpoints/{endpointsId}:countTokens",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.countTokens",
+"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/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.dataItems.annotations.operations.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1/endpoints/{endpointsId}:fetchPredictOperation",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.fetchPredictOperation",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.dataItems.annotations.operations.list",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+endpoint}:fetchPredictOperation",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"response": {
-"$ref": "GoogleLongrunningOperation"
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1/endpoints/{endpointsId}:generateContent",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.generateContent",
-"parameterOrder": [
-"model"
-],
-"parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^endpoints/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+model}:generateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
-},
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1/endpoints/{endpointsId}:predict",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.endpoints.predict",
+"id": "aiplatform.datasets.dataItems.annotations.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+endpoint}:predict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PredictRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1PredictResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1/endpoints/{endpointsId}:predictLongRunning",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.predictLongRunning",
-"parameterOrder": [
-"endpoint"
-],
-"parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
-"location": "path",
-"pattern": "^endpoints/[^/]+$",
-"required": true,
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:predictLongRunning",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
-},
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent",
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.endpoints.streamGenerateContent",
+"id": "aiplatform.datasets.dataItems.operations.cancel",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"chat": {
-"methods": {
-"completions": {
-"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
-"flatPath": "v1/endpoints/{endpointsId}/chat/completions",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.chat.completions",
+"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/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.dataItems.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}/chat/completions",
-"request": {
-"$ref": "GoogleApiHttpBody"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
-},
-"media": {
-"methods": {
-"upload": {
-"description": "Upload a file into a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload",
-"httpMethod": "POST",
-"id": "aiplatform.media.upload",
-"mediaUpload": {
-"accept": [
-"*/*"
-],
-"protocols": {
-"simple": {
-"multipart": true,
-"path": "/upload/v1/{+parent}/ragFiles:upload"
-}
-}
 },
+"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/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.dataItems.operations.get",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/ragFiles:upload",
-"request": {
-"$ref": "GoogleCloudAiplatformV1UploadRagFileRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1UploadRagFileResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
-],
-"supportsMediaUpload": true
-}
-}
+]
 },
-"projects": {
-"methods": {
-"getCacheConfig": {
-"description": "Gets a GenAI cache config.",
-"flatPath": "v1/projects/{projectsId}/cacheConfig",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.getCacheConfig",
+"id": "aiplatform.datasets.dataItems.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/cacheConfig$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CacheConfig"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"updateCacheConfig": {
-"description": "Updates a cache config.",
-"flatPath": "v1/projects/{projectsId}/cacheConfig",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.updateCacheConfig",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.datasets.dataItems.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/cacheConfig$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CacheConfig"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -1137,352 +1398,356 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"locations": {
+"datasetVersions": {
 "methods": {
-"augmentPrompt": {
-"description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt",
+"create": {
+"description": "Create a version from a Dataset.",
+"flatPath": "v1/datasets/{datasetsId}/datasetVersions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.augmentPrompt",
+"id": "aiplatform.datasets.datasetVersions.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}:augmentPrompt",
+"path": "v1/{+parent}/datasetVersions",
 "request": {
-"$ref": "GoogleCloudAiplatformV1AugmentPromptRequest"
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1AugmentPromptResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"corroborateContent": {
-"description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:corroborateContent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.corroborateContent",
+"delete": {
+"description": "Deletes a Dataset version.",
+"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.datasetVersions.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"name": {
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}:corroborateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CorroborateContentRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CorroborateContentResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deploy": {
-"description": "Deploys a model to a new endpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:deploy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploy",
+"get": {
+"description": "Gets a Dataset version.",
+"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.datasetVersions.get",
 "parameterOrder": [
-"destination"
+"name"
 ],
 "parameters": {
-"destination": {
-"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+destination}:deploy",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DeployRequest"
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"evaluateDataset": {
-"description": "Evaluates a dataset based on a set of given metrics.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluateDataset",
+"list": {
+"description": "Lists DatasetVersions in a Dataset.",
+"flatPath": "v1/datasets/{datasetsId}/datasetVersions",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.datasetVersions.list",
 "parameterOrder": [
-"location"
+"parent"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`",
+"filter": {
+"description": "Optional. The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+location}:evaluateDataset",
-"request": {
-"$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest"
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+parent}/datasetVersions",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"evaluateInstances": {
-"description": "Evaluates instances based on a given metric.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluateInstances",
+"patch": {
+"description": "Updates a DatasetVersion.",
+"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.datasets.datasetVersions.patch",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+location}:evaluateInstances",
+"path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest"
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse"
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateInstanceRubrics": {
-"description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.generateInstanceRubrics",
+"restore": {
+"description": "Restores a dataset version.",
+"flatPath": "v1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.datasetVersions.restore",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+location}:generateInstanceRubrics",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest"
-},
+"path": "v1/{+name}:restore",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"generateSyntheticData": {
-"description": "Generates synthetic data based on the provided configuration.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData",
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.generateSyntheticData",
+"id": "aiplatform.datasets.operations.cancel",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+location}:generateSyntheticData",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets information about a location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.get",
+"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/datasets/{datasetsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Resource name for the location.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudLocationLocation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getRagEngineConfig": {
-"description": "Gets a RagEngineConfig.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
+"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/datasets/{datasetsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.getRagEngineConfig",
+"id": "aiplatform.datasets.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1RagEngineConfig"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service.",
-"flatPath": "v1/projects/{projectsId}/locations",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/datasets/{datasetsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.list",
+"id": "aiplatform.datasets.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
 "filter": {
-"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "name": {
-"description": "The resource that owns the locations collection, if applicable.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of results to return. If not set, the service selects a default.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+name}/locations",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudLocationListLocationsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"retrieveContexts": {
-"description": "Retrieves relevant contexts for a query.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/datasets/{datasetsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.retrieveContexts",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}:retrieveContexts",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RetrieveContextsRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"updateRagEngineConfig": {
-"description": "Updates a RagEngineConfig.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.updateRagEngineConfig",
+"id": "aiplatform.datasets.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RagEngineConfig"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -1490,31 +1755,30 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
 },
+"savedQueries": {
 "resources": {
-"batchPredictionJobs": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.batchPredictionJobs.cancel",
+"id": "aiplatform.datasets.savedQueries.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -1522,98 +1786,77 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.batchPredictionJobs.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/batchPredictionJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
+"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/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.batchPredictionJobs.delete",
+"id": "aiplatform.datasets.savedQueries.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a BatchPredictionJob",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
+"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/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.batchPredictionJobs.get",
+"id": "aiplatform.datasets.savedQueries.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists BatchPredictionJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.batchPredictionJobs.list",
+"id": "aiplatform.datasets.savedQueries.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -1621,77 +1864,103 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.datasets.savedQueries.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/batchPredictionJobs",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
+}
+}
 },
-"cachedContents": {
+"deploymentResourcePools": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.cachedContents.create",
+"id": "aiplatform.deploymentResourcePools.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The parent resource where the cached content will be created",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/cachedContents",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CachedContent"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CachedContent"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes cached content",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"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/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.cachedContents.delete",
+"id": "aiplatform.deploymentResourcePools.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name referring to the cached content",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -1705,266 +1974,356 @@
 ]
 },
 "get": {
-"description": "Gets cached content configurations",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"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/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.cachedContents.get",
+"id": "aiplatform.deploymentResourcePools.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name referring to the cached content",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CachedContent"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists cached contents in a project",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.cachedContents.list",
+"id": "aiplatform.deploymentResourcePools.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The parent, which owns this collection of cached contents.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/cachedContents",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListCachedContentsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates cached content configurations",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.cachedContents.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.deploymentResourcePools.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The list of fields to update.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CachedContent"
-},
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CachedContent"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
 },
-"customJobs": {
+"endpoints": {
 "methods": {
-"cancel": {
-"description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel",
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1/endpoints/{endpointsId}:computeTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.cancel",
+"id": "aiplatform.endpoints.computeTokens",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+endpoint}:computeTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CancelCustomJobRequest"
+"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
 },
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs",
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1/endpoints/{endpointsId}:countTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.create",
+"id": "aiplatform.endpoints.countTokens",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/customJobs",
+"path": "v1/{+endpoint}:countTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CustomJob"
+"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1CustomJob"
+"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a CustomJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.customJobs.delete",
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1/endpoints/{endpointsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.fetchPredictOperation",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"get": {
-"description": "Gets a CustomJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.get",
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1/endpoints/{endpointsId}:generateContent",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.generateContent",
 "parameterOrder": [
-"name"
+"model"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+model}:generateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1CustomJob"
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"list": {
-"description": "Lists CustomJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.list",
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1/endpoints/{endpointsId}:predict",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.predict",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
-"location": "query",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^endpoints/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"path": "v1/{+endpoint}:predict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictRequest"
 },
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.",
-"location": "query",
-"type": "string"
+"response": {
+"$ref": "GoogleCloudAiplatformV1PredictResponse"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`",
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1/endpoints/{endpointsId}:predictLongRunning",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.predictLongRunning",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1/endpoints/{endpointsId}:streamGenerateContent",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.streamGenerateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^endpoints/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/customJobs",
+"path": "v1/{+model}:streamGenerateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse"
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 }
 },
 "resources": {
+"chat": {
+"methods": {
+"completions": {
+"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
+"flatPath": "v1/endpoints/{endpointsId}/chat/completions",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.chat.completions",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/chat/completions",
+"request": {
+"$ref": "GoogleApiHttpBody"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+},
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.operations.cancel",
+"id": "aiplatform.endpoints.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -1972,7 +2331,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -1987,9 +2346,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.customJobs.operations.delete",
+"id": "aiplatform.endpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -1997,7 +2356,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2012,9 +2371,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.operations.get",
+"id": "aiplatform.endpoints.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -2022,7 +2381,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2037,9 +2396,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations",
+"flatPath": "v1/endpoints/{endpointsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.operations.list",
+"id": "aiplatform.endpoints.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -2052,7 +2411,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2083,9 +2442,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1/endpoints/{endpointsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.operations.wait",
+"id": "aiplatform.endpoints.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -2093,7 +2452,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2116,131 +2475,81 @@
 }
 }
 },
-"dataLabelingJobs": {
-"methods": {
-"cancel": {
-"description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a DataLabelingJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/dataLabelingJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
+"featureGroups": {
+"resources": {
+"features": {
+"resources": {
+"operations": {
+"methods": {
 "delete": {
-"description": "Deletes a DataLabelingJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
+"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/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.dataLabelingJobs.delete",
+"id": "aiplatform.featureGroups.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a DataLabelingJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
+"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/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.get",
+"id": "aiplatform.featureGroups.features.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists DataLabelingJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
+"listWait": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.list",
+"id": "aiplatform.featureGroups.features.operations.listWait",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -2254,62 +2563,62 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/dataLabelingJobs",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel",
+"id": "aiplatform.featureGroups.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
+"operations": {
+"methods": {
 "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/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete",
+"id": "aiplatform.featureGroups.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -2317,7 +2626,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2332,9 +2641,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.get",
+"id": "aiplatform.featureGroups.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -2342,7 +2651,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2355,11 +2664,11 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
+"listWait": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations",
+"flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.list",
+"id": "aiplatform.featureGroups.operations.listWait",
 "parameterOrder": [
 "name"
 ],
@@ -2372,7 +2681,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2393,7 +2702,7 @@
 "type": "boolean"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningListOperationsResponse"
 },
@@ -2403,9 +2712,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait",
+"id": "aiplatform.featureGroups.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -2413,7 +2722,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2436,82 +2745,55 @@
 }
 }
 },
-"datasets": {
+"featureOnlineStores": {
+"resources": {
+"featureViews": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/datasets",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Dataset"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"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/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.delete",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"export": {
-"description": "Exports data from a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.export",
+"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/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:export",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ExportDataRequest"
-},
+"path": "v1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -2519,292 +2801,233 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"listWait": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.get",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.listWait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The name of the Dataset resource.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Dataset"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"import": {
-"description": "Imports data into a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.import",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+name}:import",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ImportDataRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"list": {
-"description": "Lists Datasets in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.list",
+"operations": {
+"methods": {
+"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/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.featureOnlineStores.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/datasets",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListDatasetsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.datasets.patch",
+"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/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.featureOnlineStores.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Dataset"
-},
 "response": {
-"$ref": "GoogleCloudAiplatformV1Dataset"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"searchDataItems": {
-"description": "Searches DataItems in a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems",
+"listWait": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.searchDataItems",
+"id": "aiplatform.featureOnlineStores.operations.listWait",
 "parameterOrder": [
-"dataset"
+"name"
 ],
 "parameters": {
-"annotationFilters": {
-"description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"annotationsFilter": {
-"deprecated": true,
-"description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.",
-"location": "query",
-"type": "string"
-},
-"annotationsLimit": {
-"description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"dataItemFilter": {
-"description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`",
-"location": "query",
-"type": "string"
-},
-"dataLabelingJob": {
-"description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.",
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"dataset": {
-"description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"fieldMask": {
-"description": "Mask specifying which fields of DataItemView to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"deprecated": true,
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
-"type": "string"
-},
-"orderByAnnotation.orderBy": {
-"description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.",
-"location": "query",
-"type": "string"
-},
-"orderByAnnotation.savedQuery": {
-"description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.",
-"location": "query",
-"type": "string"
-},
-"orderByDataItem": {
-"description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
-"type": "string"
-},
 "pageSize": {
-"description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"savedQuery": {
-"deprecated": true,
-"description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/{+dataset}:searchDataItems",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"annotationSpecs": {
-"methods": {
-"get": {
-"description": "Gets an AnnotationSpec.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.get",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.featureOnlineStores.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1AnnotationSpec"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"featurestores": {
+"resources": {
+"entityTypes": {
+"resources": {
+"features": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel",
+"id": "aiplatform.featurestores.entityTypes.features.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -2812,7 +3035,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2827,9 +3050,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete",
+"id": "aiplatform.featurestores.entityTypes.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -2837,7 +3060,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2852,9 +3075,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get",
+"id": "aiplatform.featurestores.entityTypes.features.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -2862,7 +3085,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2877,9 +3100,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list",
+"id": "aiplatform.featurestores.entityTypes.features.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -2892,7 +3115,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2923,9 +3146,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait",
+"id": "aiplatform.featurestores.entityTypes.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -2933,7 +3156,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2956,71 +3179,90 @@
 }
 }
 },
-"dataItems": {
+"operations": {
 "methods": {
-"list": {
-"description": "Lists DataItems in a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.list",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.featurestores.entityTypes.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
-"type": "string"
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"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/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.featurestores.entityTypes.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.featurestores.entityTypes.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/dataItems",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListDataItemsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"annotations": {
-"methods": {
 "list": {
-"description": "Lists Annotations belongs to a dataitem.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.list",
+"id": "aiplatform.featurestores.entityTypes.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
@@ -3028,9 +3270,11 @@
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -3044,37 +3288,62 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.featurestores.entityTypes.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/annotations",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel",
+"id": "aiplatform.featurestores.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -3082,7 +3351,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3097,9 +3366,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete",
+"id": "aiplatform.featurestores.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3107,7 +3376,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3122,9 +3391,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get",
+"id": "aiplatform.featurestores.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3132,7 +3401,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3147,9 +3416,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations",
+"flatPath": "v1/featurestores/{featurestoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list",
+"id": "aiplatform.featurestores.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3162,7 +3431,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
+"pattern": "^featurestores/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3193,9 +3462,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait",
+"flatPath": "v1/featurestores/{featurestoresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait",
+"id": "aiplatform.featurestores.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3203,7 +3472,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3226,13 +3495,15 @@
 }
 }
 },
+"hyperparameterTuningJobs": {
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel",
+"id": "aiplatform.hyperparameterTuningJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -3240,7 +3511,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3255,9 +3526,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.delete",
+"id": "aiplatform.hyperparameterTuningJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3265,7 +3536,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3280,9 +3551,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.get",
+"id": "aiplatform.hyperparameterTuningJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3290,7 +3561,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3305,9 +3576,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations",
+"flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.list",
+"id": "aiplatform.hyperparameterTuningJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3320,7 +3591,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3351,9 +3622,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait",
+"flatPath": "v1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.wait",
+"id": "aiplatform.hyperparameterTuningJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3361,7 +3632,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3384,196 +3655,155 @@
 }
 }
 },
-"datasetVersions": {
+"indexEndpoints": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Create a version from a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.create",
+"id": "aiplatform.indexEndpoints.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/datasetVersions",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a Dataset version.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"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/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.delete",
+"id": "aiplatform.indexEndpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Dataset version.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"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/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.get",
+"id": "aiplatform.indexEndpoints.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists DatasetVersions in a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.list",
+"id": "aiplatform.indexEndpoints.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^indexEndpoints/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/datasetVersions",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a DatasetVersion.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.indexEndpoints.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1DatasetVersion"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"restore": {
-"description": "Restores a dataset version.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.restore",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:restore",
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -3582,14 +3812,18 @@
 ]
 }
 }
+}
+}
 },
+"indexes": {
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.operations.cancel",
+"id": "aiplatform.indexes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -3597,7 +3831,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3612,9 +3846,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"flatPath": "v1/indexes/{indexesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.operations.delete",
+"id": "aiplatform.indexes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3622,7 +3856,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3637,9 +3871,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"flatPath": "v1/indexes/{indexesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.operations.get",
+"id": "aiplatform.indexes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3647,7 +3881,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3662,9 +3896,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations",
+"flatPath": "v1/indexes/{indexesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.operations.list",
+"id": "aiplatform.indexes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3677,7 +3911,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^indexes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3708,9 +3942,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait",
+"flatPath": "v1/indexes/{indexesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.operations.wait",
+"id": "aiplatform.indexes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3718,7 +3952,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3738,22 +3972,122 @@
 ]
 }
 }
+}
+}
 },
-"savedQueries": {
+"media": {
+"methods": {
+"upload": {
+"description": "Upload a file into a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload",
+"httpMethod": "POST",
+"id": "aiplatform.media.upload",
+"mediaUpload": {
+"accept": [
+"*/*"
+],
+"protocols": {
+"simple": {
+"multipart": true,
+"path": "/upload/v1/{+parent}/ragFiles:upload"
+}
+}
+},
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/ragFiles:upload",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UploadRagFileRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1UploadRagFileResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+],
+"supportsMediaUpload": true
+}
+}
+},
+"metadataStores": {
+"resources": {
+"artifacts": {
+"resources": {
+"operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.metadataStores.artifacts.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
-"description": "Deletes a SavedQuery.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}",
+"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/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.savedQueries.delete",
+"id": "aiplatform.metadataStores.artifacts.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.metadataStores.artifacts.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3767,12 +4101,12 @@
 ]
 },
 "list": {
-"description": "Lists SavedQueries in a Dataset.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.savedQueries.list",
+"id": "aiplatform.metadataStores.artifacts.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
@@ -3780,9 +4114,11 @@
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -3796,37 +4132,64 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.metadataStores.artifacts.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/savedQueries",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"contexts": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel",
+"id": "aiplatform.metadataStores.contexts.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -3834,7 +4197,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3849,9 +4212,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
+"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete",
+"id": "aiplatform.metadataStores.contexts.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3859,7 +4222,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3874,9 +4237,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
+"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.get",
+"id": "aiplatform.metadataStores.contexts.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3884,7 +4247,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3899,9 +4262,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
+"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.list",
+"id": "aiplatform.metadataStores.contexts.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3914,7 +4277,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3945,9 +4308,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
+"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait",
+"id": "aiplatform.metadataStores.contexts.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3955,7 +4318,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3977,204 +4340,174 @@
 }
 }
 }
-}
-}
 },
-"deploymentResourcePools": {
+"executions": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Create a DeploymentResourcePool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploymentResourcePools.create",
+"id": "aiplatform.metadataStores.executions.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/deploymentResourcePools",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Delete a DeploymentResourcePool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"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/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.deploymentResourcePools.delete",
+"id": "aiplatform.metadataStores.executions.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Get a DeploymentResourcePool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"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/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.get",
+"id": "aiplatform.metadataStores.executions.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "List DeploymentResourcePools in a location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.list",
+"id": "aiplatform.metadataStores.executions.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/deploymentResourcePools",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Update a DeploymentResourcePool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.deploymentResourcePools.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.metadataStores.executions.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The list of fields to update.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
-},
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"queryDeployedModels": {
-"description": "List DeployedModels that have been deployed on this DeploymentResourcePool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels",
-"parameterOrder": [
-"deploymentResourcePool"
-],
-"parameters": {
-"deploymentResourcePool": {
-"description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
-"required": true,
-"type": "string"
-},
-"pageSize": {
-"description": "The maximum number of DeployedModels to return. The service may return fewer than this value.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1/{+deploymentResourcePool}:queryDeployedModels",
-"response": {
-"$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+}
+}
 }
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel",
+"id": "aiplatform.metadataStores.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -4182,7 +4515,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4197,9 +4530,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete",
+"id": "aiplatform.metadataStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -4207,7 +4540,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4222,9 +4555,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.get",
+"id": "aiplatform.metadataStores.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -4232,7 +4565,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4247,9 +4580,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations",
+"flatPath": "v1/metadataStores/{metadataStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.list",
+"id": "aiplatform.metadataStores.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -4262,7 +4595,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4293,9 +4626,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait",
+"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait",
+"id": "aiplatform.metadataStores.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -4303,7 +4636,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4326,90 +4659,78 @@
 }
 }
 },
-"endpoints": {
+"migratableResources": {
+"resources": {
+"operations": {
 "methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.computeTokens",
+"id": "aiplatform.migratableResources.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:computeTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.countTokens",
+"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/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.migratableResources.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates an Endpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.create",
+"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/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.migratableResources.operations.get",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"endpointId": {
-"description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/endpoints",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Endpoint"
-},
+"path": "v1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -4417,307 +4738,7247 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes an Endpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.endpoints.delete",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/migratableResources/{migratableResourcesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.migratableResources.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^migratableResources/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deployModel": {
-"description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.deployModel",
+"id": "aiplatform.migratableResources.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+endpoint}:deployModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DeployModelRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"directPredict": {
-"description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict",
+"modelDeploymentMonitoringJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.directPredict",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:directPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DirectPredictRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DirectPredictResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"directRawPredict": {
-"description": "Perform an unary online prediction request to a gRPC model server for custom containers.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.directRawPredict",
+"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/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:directRawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DirectRawPredictRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse"
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"models": {
+"resources": {
+"evaluations": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.models.evaluations.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.models.evaluations.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.models.evaluations.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.models.evaluations.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^models/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.models.evaluations.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/models/{modelsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.models.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/models/{modelsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.models.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/models/{modelsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.models.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/models/{modelsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.models.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/models/{modelsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.models.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookExecutionJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.notebookExecutionJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.notebookExecutionJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.notebookExecutionJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.notebookExecutionJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^notebookExecutionJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.notebookExecutionJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookRuntimeTemplates": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.notebookRuntimeTemplates.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.notebookRuntimeTemplates.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.notebookRuntimeTemplates.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.notebookRuntimeTemplates.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.notebookRuntimeTemplates.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookRuntimes": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.notebookRuntimes.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.notebookRuntimes.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.notebookRuntimes.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.notebookRuntimes.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.notebookRuntimes.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/operations",
+"httpMethod": "GET",
+"id": "aiplatform.operations.list",
+"parameterOrder": [],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"persistentResources": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.persistentResources.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.persistentResources.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.persistentResources.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/persistentResources/{persistentResourcesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.persistentResources.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.persistentResources.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"pipelineJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.pipelineJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.pipelineJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.pipelineJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.pipelineJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^pipelineJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.pipelineJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"projects": {
+"methods": {
+"getCacheConfig": {
+"description": "Gets a GenAI cache config.",
+"flatPath": "v1/projects/{projectsId}/cacheConfig",
+"httpMethod": "GET",
+"id": "aiplatform.projects.getCacheConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/cacheConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1CacheConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateCacheConfig": {
+"description": "Updates a cache config.",
+"flatPath": "v1/projects/{projectsId}/cacheConfig",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.updateCacheConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/cacheConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CacheConfig"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"locations": {
+"methods": {
+"augmentPrompt": {
+"description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:augmentPrompt",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.augmentPrompt",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:augmentPrompt",
+"request": {
+"$ref": "GoogleCloudAiplatformV1AugmentPromptRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1AugmentPromptResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"corroborateContent": {
+"description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:corroborateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.corroborateContent",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:corroborateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CorroborateContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1CorroborateContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"deploy": {
+"description": "Deploys a model to a new endpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:deploy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.deploy",
+"parameterOrder": [
+"destination"
+],
+"parameters": {
+"destination": {
+"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+destination}:deploy",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DeployRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"evaluateDataset": {
+"description": "Evaluates a dataset based on a set of given metrics.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateDataset",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluateDataset",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+location}:evaluateDataset",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EvaluateDatasetRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"evaluateInstances": {
+"description": "Evaluates instances based on a given metric.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:evaluateInstances",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluateInstances",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+location}:evaluateInstances",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EvaluateInstancesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluateInstancesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generateInstanceRubrics": {
+"description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.generateInstanceRubrics",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+location}:generateInstanceRubrics",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1GenerateInstanceRubricsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generateSyntheticData": {
+"description": "Generates synthetic data based on the provided configuration.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.generateSyntheticData",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+location}:generateSyntheticData",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1GenerateSyntheticDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets information about a location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Resource name for the location.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudLocationLocation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getRagEngineConfig": {
+"description": "Gets a RagEngineConfig.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.getRagEngineConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1RagEngineConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists information about the supported locations for this service.",
+"flatPath": "v1/projects/{projectsId}/locations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"extraLocationTypes": {
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter": {
+"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The resource that owns the locations collection, if applicable.",
+"location": "path",
+"pattern": "^projects/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of results to return. If not set, the service selects a default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}/locations",
+"response": {
+"$ref": "GoogleCloudLocationListLocationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"retrieveContexts": {
+"description": "Retrieves relevant contexts for a query.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:retrieveContexts",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.retrieveContexts",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:retrieveContexts",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RetrieveContextsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1RetrieveContextsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateRagEngineConfig": {
+"description": "Updates a RagEngineConfig.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.updateRagEngineConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RagEngineConfig"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"batchPredictionJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.batchPredictionJobs.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CancelBatchPredictionJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.batchPredictionJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/batchPredictionJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.batchPredictionJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a BatchPredictionJob",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.batchPredictionJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1BatchPredictionJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists BatchPredictionJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.batchPredictionJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/batchPredictionJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListBatchPredictionJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"cachedContents": {
+"methods": {
+"create": {
+"description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.cachedContents.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource where the cached content will be created",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/cachedContents",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CachedContent"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1CachedContent"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes cached content",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.cachedContents.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name referring to the cached content",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets cached content configurations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.cachedContents.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name referring to the cached content",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1CachedContent"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists cached contents in a project",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.cachedContents.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent, which owns this collection of cached contents.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/cachedContents",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListCachedContentsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates cached content configurations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.cachedContents.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The list of fields to update.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CachedContent"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1CachedContent"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"customJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CancelCustomJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/customJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CustomJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1CustomJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a CustomJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.customJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a CustomJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1CustomJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists CustomJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/customJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListCustomJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.customJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"dataLabelingJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.dataLabelingJobs.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CancelDataLabelingJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a DataLabelingJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.dataLabelingJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/dataLabelingJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a DataLabelingJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.dataLabelingJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a DataLabelingJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.dataLabelingJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1DataLabelingJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists DataLabelingJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.dataLabelingJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/dataLabelingJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListDataLabelingJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"datasets": {
+"methods": {
+"create": {
+"description": "Creates a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/datasets",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Dataset"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"export": {
+"description": "Exports data from a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.export",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:export",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ExportDataRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Dataset resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1Dataset"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Imports data into a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.import",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ImportDataRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Datasets in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/datasets",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListDatasetsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.datasets.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Dataset"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1Dataset"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"searchDataItems": {
+"description": "Searches DataItems in a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.searchDataItems",
+"parameterOrder": [
+"dataset"
+],
+"parameters": {
+"annotationFilters": {
+"description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"annotationsFilter": {
+"deprecated": true,
+"description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.",
+"location": "query",
+"type": "string"
+},
+"annotationsLimit": {
+"description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"dataItemFilter": {
+"description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`",
+"location": "query",
+"type": "string"
+},
+"dataLabelingJob": {
+"description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.",
+"location": "query",
+"type": "string"
+},
+"dataset": {
+"description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"fieldMask": {
+"description": "Mask specifying which fields of DataItemView to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"deprecated": true,
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"orderByAnnotation.orderBy": {
+"description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.",
+"location": "query",
+"type": "string"
+},
+"orderByAnnotation.savedQuery": {
+"description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.",
+"location": "query",
+"type": "string"
+},
+"orderByDataItem": {
+"description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.",
+"location": "query",
+"type": "string"
+},
+"savedQuery": {
+"deprecated": true,
+"description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+dataset}:searchDataItems",
+"response": {
+"$ref": "GoogleCloudAiplatformV1SearchDataItemsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"annotationSpecs": {
+"methods": {
+"get": {
+"description": "Gets an AnnotationSpec.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1AnnotationSpec"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"dataItems": {
+"methods": {
+"list": {
+"description": "Lists DataItems in a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/dataItems",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListDataItemsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"annotations": {
+"methods": {
+"list": {
+"description": "Lists Annotations belongs to a dataitem.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/annotations",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListAnnotationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"datasetVersions": {
+"methods": {
+"create": {
+"description": "Create a version from a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/datasetVersions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Dataset version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Dataset version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists DatasetVersions in a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/datasetVersions",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a DatasetVersion.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1DatasetVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"restore": {
+"description": "Restores a dataset version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.restore",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:restore",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"savedQueries": {
+"methods": {
+"delete": {
+"description": "Deletes a SavedQuery.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.savedQueries.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists SavedQueries in a Dataset.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.savedQueries.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/savedQueries",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListSavedQueriesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+}
+},
+"deploymentResourcePools": {
+"methods": {
+"create": {
+"description": "Create a DeploymentResourcePool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.deploymentResourcePools.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/deploymentResourcePools",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Delete a DeploymentResourcePool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.deploymentResourcePools.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Get a DeploymentResourcePool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.deploymentResourcePools.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "List DeploymentResourcePools in a location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.deploymentResourcePools.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/deploymentResourcePools",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListDeploymentResourcePoolsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Update a DeploymentResourcePool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.deploymentResourcePools.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The list of fields to update.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DeploymentResourcePool"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"queryDeployedModels": {
+"description": "List DeployedModels that have been deployed on this DeploymentResourcePool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels",
+"parameterOrder": [
+"deploymentResourcePool"
+],
+"parameters": {
+"deploymentResourcePool": {
+"description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of DeployedModels to return. The service may return fewer than this value.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+deploymentResourcePool}:queryDeployedModels",
+"response": {
+"$ref": "GoogleCloudAiplatformV1QueryDeployedModelsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"endpoints": {
+"methods": {
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.computeTokens",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:computeTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.countTokens",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:countTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates an Endpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"endpointId": {
+"description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/endpoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Endpoint"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes an Endpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.endpoints.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"deployModel": {
+"description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.deployModel",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:deployModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DeployModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"directPredict": {
+"description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.directPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:directPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DirectPredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1DirectPredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"directRawPredict": {
+"description": "Perform an unary online prediction request to a gRPC model server for custom containers.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.directRawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:directRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DirectRawPredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1DirectRawPredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"explain": {
+"description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.explain",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:explain",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ExplainRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1ExplainResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.fetchPredictOperation",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.generateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+model}:generateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"get": {
+"description": "Gets an Endpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.endpoints.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1Endpoint"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Endpoints in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.endpoints.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"location": "query",
+"type": "string"
+},
+"gdcZone": {
+"description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/endpoints",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListEndpointsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"mutateDeployedModel": {
+"description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.mutateDeployedModel",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:mutateDeployedModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1MutateDeployedModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates an Endpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.endpoints.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. The resource name of the Endpoint.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Endpoint"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1Endpoint"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.predict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:predict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1PredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.predictLongRunning",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"rawPredict": {
+"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.rawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:rawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RawPredictRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"serverStreamingPredict": {
+"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.serverStreamingPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:serverStreamingPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamingPredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1StreamingPredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.streamGenerateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+model}:streamGenerateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"streamRawPredict": {
+"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.streamRawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:streamRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"undeployModel": {
+"description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.undeployModel",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}:undeployModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UndeployModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"update": {
+"description": "Updates an Endpoint with a long running operation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.update",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. The resource name of the Endpoint.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:update",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"chat": {
+"methods": {
+"completions": {
+"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.chat.completions",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/chat/completions",
+"request": {
+"$ref": "GoogleApiHttpBody"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+},
+"deployedModels": {
+"resources": {
+"invoke": {
+"methods": {
+"invoke": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke",
+"parameterOrder": [
+"endpoint",
+"deployedModelId",
+"invokeId"
+],
+"parameters": {
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"invokeId": {
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1InvokeRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+}
+}
+},
+"invoke": {
+"methods": {
+"invoke": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.invoke.invoke",
+"parameterOrder": [
+"endpoint",
+"invokeId"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"invokeId": {
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/invoke/{+invokeId}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1InvokeRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+},
+"openapi": {
+"methods": {
+"embeddings": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.openapi.embeddings",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
+"location": "query",
+"type": "string"
+},
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+endpoint}/embeddings",
+"request": {
+"$ref": "GoogleApiHttpBody"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.endpoints.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.endpoints.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.endpoints.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"evaluationItems": {
+"methods": {
+"create": {
+"description": "Creates an Evaluation Item.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluationItems.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/evaluationItems",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EvaluationItem"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationItem"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes an Evaluation Item.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.evaluationItems.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets an Evaluation Item.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationItems.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationItem"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Evaluation Items.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationItems.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of Evaluation Items to return.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/evaluationItems",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"evaluationRuns": {
+"methods": {
+"cancel": {
+"description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluationRuns.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates an Evaluation Run.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluationRuns.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/evaluationRuns",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EvaluationRun"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationRun"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes an Evaluation Run.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.evaluationRuns.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets an Evaluation Run.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationRuns.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationRun"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Evaluation Runs.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationRuns.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of Evaluation Runs to return.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/evaluationRuns",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"evaluationSets": {
+"methods": {
+"create": {
+"description": "Creates an Evaluation Set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluationSets.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/evaluationSets",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes an Evaluation Set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.evaluationSets.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets an Evaluation Set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationSets.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Evaluation Sets.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationSets.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of Evaluation Sets to return.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/evaluationSets",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates an Evaluation Set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.evaluationSets.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"featureGroups": {
+"methods": {
+"create": {
+"description": "Creates a new FeatureGroup in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"featureGroupId": {
+"description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/featureGroups",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FeatureGroup"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a single FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of a single FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the FeatureGroup resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1FeatureGroup"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists FeatureGroups in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/featureGroups",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListFeatureGroupsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates the parameters of a single FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureGroups.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FeatureGroup"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:testIamPermissions",
+"response": {
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"features": {
+"methods": {
+"batchCreate": {
+"description": "Creates a batch of Features in a given FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.features.batchCreate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/features:batchCreate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a new Feature in a given FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.features.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"featureId": {
+"description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/features",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Feature"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a single Feature.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.features.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of a single Feature.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.features.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1Feature"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Features in a given FeatureGroup.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.features.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.",
+"location": "query",
+"type": "string"
+},
+"latestStatsCount": {
+"description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+parent}/features",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListFeaturesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"explain": {
-"description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain",
+"patch": {
+"description": "Updates the parameters of a single Feature.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureGroups.features.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Feature"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"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/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listWait": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.listWait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.explain",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+endpoint}:explain",
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"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/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listWait": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.operations.listWait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"featureOnlineStores": {
+"methods": {
+"create": {
+"description": "Creates a new FeatureOnlineStore in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"featureOnlineStoreId": {
+"description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/featureOnlineStores",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ExplainRequest"
+"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ExplainResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation",
+"delete": {
+"description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureOnlineStores.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of a single FeatureOnlineStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the FeatureOnlineStore resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.fetchPredictOperation",
+"id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy",
 "parameterOrder": [
-"endpoint"
+"resource"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists FeatureOnlineStores in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/featureOnlineStores",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates the parameters of a single FeatureOnlineStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureOnlineStores.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+endpoint}:fetchPredictOperation",
+"path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.generateContent",
+"id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy",
 "parameterOrder": [
-"model"
+"resource"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:generateContent",
+"path": "v1/{+resource}:setIamPolicy",
 "request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+"$ref": "GoogleIamV1SetIamPolicyRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets an Endpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.get",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Endpoint"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"list": {
-"description": "Lists Endpoints in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.list",
+"resources": {
+"featureViews": {
+"methods": {
+"create": {
+"description": "Creates a new FeatureView in a given FeatureOnlineStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
-"location": "query",
-"type": "string"
-},
-"gdcZone": {
-"description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.",
+"featureViewId": {
+"description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"runSyncImmediately": {
+"description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/endpoints",
+"path": "v1/{+parent}/featureViews",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FeatureView"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListEndpointsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"mutateDeployedModel": {
-"description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.mutateDeployedModel",
+"delete": {
+"description": "Deletes a single FeatureView.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:mutateDeployedModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1MutateDeployedModelRequest"
-},
+"path": "v1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -4725,464 +11986,425 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an Endpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.endpoints.patch",
+"directWrite": {
+"description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite",
 "parameterOrder": [
-"name"
+"featureView"
 ],
 "parameters": {
-"name": {
-"description": "Output only. The resource name of the Endpoint.",
+"featureView": {
+"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+featureView}:directWrite",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Endpoint"
+"$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Endpoint"
+"$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict",
+"fetchFeatureValues": {
+"description": "Fetch feature values under a FeatureView.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.predict",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues",
 "parameterOrder": [
-"endpoint"
+"featureView"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"featureView": {
+"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:predict",
+"path": "v1/{+featureView}:fetchFeatureValues",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PredictRequest"
+"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1PredictResponse"
+"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning",
+"generateFetchAccessToken": {
+"description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.predictLongRunning",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken",
 "parameterOrder": [
-"endpoint"
+"featureView"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"featureView": {
+"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:predictLongRunning",
+"path": "v1/{+featureView}:generateFetchAccessToken",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
+"$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"rawPredict": {
-"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.rawPredict",
+"get": {
+"description": "Gets details of a single FeatureView.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:rawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RawPredictRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1FeatureView"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"serverStreamingPredict": {
-"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict",
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.serverStreamingPredict",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy",
 "parameterOrder": [
-"endpoint"
+"resource"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:serverStreamingPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1StreamingPredictRequest"
-},
+"path": "v1/{+resource}:getIamPolicy",
 "response": {
-"$ref": "GoogleCloudAiplatformV1StreamingPredictResponse"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.streamGenerateContent",
+"list": {
+"description": "Lists FeatureViews in a given FeatureOnlineStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list",
 "parameterOrder": [
-"model"
+"parent"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
-},
+"path": "v1/{+parent}/featureViews",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleCloudAiplatformV1ListFeatureViewsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamRawPredict": {
-"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.streamRawPredict",
+"patch": {
+"description": "Updates the parameters of a single FeatureView.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+endpoint}:streamRawPredict",
+"path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest"
+"$ref": "GoogleCloudAiplatformV1FeatureView"
 },
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"undeployModel": {
-"description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel",
+"searchNearestEntities": {
+"description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.undeployModel",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities",
 "parameterOrder": [
-"endpoint"
+"featureView"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"featureView": {
+"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:undeployModel",
+"path": "v1/{+featureView}:searchNearestEntities",
 "request": {
-"$ref": "GoogleCloudAiplatformV1UndeployModelRequest"
+"$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"update": {
-"description": "Updates an Endpoint with a long running operation.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.update",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Output only. The resource name of the Endpoint.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:update",
+"path": "v1/{+resource}:setIamPolicy",
 "request": {
-"$ref": "GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest"
+"$ref": "GoogleIamV1SetIamPolicyRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"chat": {
-"methods": {
-"completions": {
-"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions",
+"sync": {
+"description": "Triggers on-demand sync for the FeatureView.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.chat.completions",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync",
 "parameterOrder": [
-"endpoint"
+"featureView"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"featureView": {
+"description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}/chat/completions",
+"path": "v1/{+featureView}:sync",
 "request": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1SyncFeatureViewRequest"
 },
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1SyncFeatureViewResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"deployedModels": {
-"resources": {
-"invoke": {
-"methods": {
-"invoke": {
-"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions",
 "parameterOrder": [
-"endpoint",
-"deployedModelId",
-"invokeId"
+"resource"
 ],
 "parameters": {
-"deployedModelId": {
-"description": "ID of the DeployedModel that serves the invoke request.",
-"location": "path",
-"required": true,
-"type": "string"
-},
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
-"required": true,
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
 "type": "string"
 },
-"invokeId": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1InvokeRequest"
-},
+"path": "v1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
 },
-"invoke": {
+"resources": {
+"featureViewSyncs": {
 "methods": {
-"invoke": {
-"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.invoke.invoke",
+"get": {
+"description": "Gets details of a single FeatureViewSync.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get",
 "parameterOrder": [
-"endpoint",
-"invokeId"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
-"required": true,
-"type": "string"
-},
-"invokeId": {
+"name": {
+"description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`",
 "location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}/invoke/{+invokeId}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1InvokeRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1FeatureViewSync"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"openapi": {
-"methods": {
-"embeddings": {
-"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.openapi.embeddings",
+"list": {
+"description": "Lists FeatureViewSyncs in a given FeatureView.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list",
 "parameterOrder": [
-"endpoint"
+"parent"
 ],
 "parameters": {
-"deployedModelId": {
-"description": "ID of the DeployedModel that serves the invoke request.",
+"filter": {
+"description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.",
 "location": "query",
 "type": "string"
 },
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$",
-"required": true,
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`",
+"location": "query",
 "type": "string"
-}
 },
-"path": "v1/{+endpoint}/embeddings",
-"request": {
-"$ref": "GoogleApiHttpBody"
-},
-"response": {
-"$ref": "GoogleApiHttpBody"
+"pageSize": {
+"description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-}
-}
+"pageToken": {
+"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.",
+"location": "query",
+"type": "string"
 },
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"parent": {
+"description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+parent}/featureViewSyncs",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
+"operations": {
+"methods": {
 "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/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.endpoints.operations.delete",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -5190,7 +12412,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5205,9 +12427,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.operations.get",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -5215,7 +12437,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5228,11 +12450,11 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
+"listWait": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.operations.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait",
 "parameterOrder": [
 "name"
 ],
@@ -5245,7 +12467,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -5266,7 +12488,7 @@
 "type": "boolean"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningListOperationsResponse"
 },
@@ -5276,9 +12498,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.operations.wait",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -5286,7 +12508,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -5309,205 +12531,220 @@
 }
 }
 },
-"evaluationItems": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates an Evaluation Item.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationItems.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/evaluationItems",
-"request": {
-"$ref": "GoogleCloudAiplatformV1EvaluationItem"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationItem"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes an Evaluation Item.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
+"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/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationItems.delete",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets an Evaluation Item.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationItems.get",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationItem"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists Evaluation Items.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
+"listWait": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationItems.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.listWait",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of Evaluation Items to return.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/evaluationItems",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListEvaluationItemsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
 },
-"evaluationRuns": {
+"featurestores": {
 "methods": {
-"cancel": {
-"description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel",
+"batchReadFeatureValues": {
+"description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationRuns.cancel",
+"id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues",
 "parameterOrder": [
-"name"
+"featurestore"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"featurestore": {
+"description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+featurestore}:batchReadFeatureValues",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CancelEvaluationRunRequest"
+"$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest"
 },
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "create": {
-"description": "Creates an Evaluation Run.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
+"description": "Creates a new Featurestore in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationRuns.create",
+"id": "aiplatform.projects.locations.featurestores.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"featurestoreId": {
+"description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"location": "query",
+"type": "string"
+},
 "parent": {
-"description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/evaluationRuns",
+"path": "v1/{+parent}/featurestores",
 "request": {
-"$ref": "GoogleCloudAiplatformV1EvaluationRun"
+"$ref": "GoogleCloudAiplatformV1Featurestore"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationRun"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an Evaluation Run.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationRuns.delete",
+"id": "aiplatform.projects.locations.featurestores.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5521,267 +12758,334 @@
 ]
 },
 "get": {
-"description": "Gets an Evaluation Run.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"description": "Gets details of a single Featurestore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationRuns.get",
+"id": "aiplatform.projects.locations.featurestores.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"description": "Required. The name of the Featurestore resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationRun"
+"$ref": "GoogleCloudAiplatformV1Featurestore"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Evaluation Runs.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
+"description": "Lists Featurestores in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationRuns.list",
+"id": "aiplatform.projects.locations.featurestores.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of Evaluation Runs to return.",
+"description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.",
+"description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/evaluationRuns",
+"path": "v1/{+parent}/featurestores",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListEvaluationRunsResponse"
+"$ref": "GoogleCloudAiplatformV1ListFeaturestoresResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"evaluationSets": {
-"methods": {
-"create": {
-"description": "Creates an Evaluation Set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationSets.create",
+"patch": {
+"description": "Updates the parameters of a single Featurestore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featurestores.patch",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/evaluationSets",
+"path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+"$ref": "GoogleCloudAiplatformV1Featurestore"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes an Evaluation Set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationSets.delete",
+"searchFeatures": {
+"description": "Searches Features matching a query in a given project.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featurestores.searchFeatures",
 "parameterOrder": [
-"name"
+"location"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"location": {
+"description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pageSize": {
+"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"query": {
+"description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+location}/featurestores:searchFeatures",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1SearchFeaturesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets an Evaluation Set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationSets.get",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.setIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists Evaluation Sets.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationSets.list",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.testIamPermissions",
 "parameterOrder": [
-"parent"
+"resource"
 ],
 "parameters": {
-"filter": {
-"description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
 "location": "query",
+"repeated": true,
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"pageSize": {
-"description": "Optional. The maximum number of Evaluation Sets to return.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"path": "v1/{+resource}:testIamPermissions",
+"response": {
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
-"pageToken": {
-"description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.",
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"entityTypes": {
+"methods": {
+"create": {
+"description": "Creates a new EntityType in a given Featurestore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"entityTypeId": {
+"description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/evaluationSets",
+"path": "v1/{+parent}/entityTypes",
+"request": {
+"$ref": "GoogleCloudAiplatformV1EntityType"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListEvaluationSetsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an Evaluation Set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.evaluationSets.patch",
+"delete": {
+"description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1EvaluationSet"
-},
 "response": {
-"$ref": "GoogleCloudAiplatformV1EvaluationSet"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"featureGroups": {
-"methods": {
-"create": {
-"description": "Creates a new FeatureGroup in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups",
+"deleteFeatureValues": {
+"description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.create",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues",
 "parameterOrder": [
-"parent"
+"entityType"
 ],
 "parameters": {
-"featureGroupId": {
-"description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`",
+"entityType": {
+"description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/featureGroups",
+"path": "v1/{+entityType}:deleteFeatureValues",
 "request": {
-"$ref": "GoogleCloudAiplatformV1FeatureGroup"
+"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -5790,29 +13094,27 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a single FeatureGroup.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.delete",
+"exportFeatureValues": {
+"description": "Exports Feature values from all the entities of a target EntityType.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues",
 "parameterOrder": [
-"name"
+"entityType"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)",
-"location": "query",
-"type": "boolean"
-},
-"name": {
-"description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"entityType": {
+"description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+entityType}:exportFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -5821,25 +13123,25 @@
 ]
 },
 "get": {
-"description": "Gets details of a single FeatureGroup.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
+"description": "Gets details of a single EntityType.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureGroup resource.",
+"description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1FeatureGroup"
+"$ref": "GoogleCloudAiplatformV1EntityType"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -5847,9 +13149,9 @@
 },
 "getIamPolicy": {
 "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.getIamPolicy",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy",
 "parameterOrder": [
 "resource"
 ],
@@ -5863,7 +13165,7 @@
 "resource": {
 "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5876,70 +13178,104 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"importFeatureValues": {
+"description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues",
+"parameterOrder": [
+"entityType"
+],
+"parameters": {
+"entityType": {
+"description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+entityType}:importFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
-"description": "Lists FeatureGroups in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups",
+"description": "Lists EntityTypes in a given Featurestore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.list",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".",
+"description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.",
+"description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/featureGroups",
+"path": "v1/{+parent}/entityTypes",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListFeatureGroupsResponse"
+"$ref": "GoogleCloudAiplatformV1ListEntityTypesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates the parameters of a single FeatureGroup.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
+"description": "Updates the parameters of a single EntityType.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureGroups.patch",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
+"description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`",
+"description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -5947,10 +13283,38 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1FeatureGroup"
+"$ref": "GoogleCloudAiplatformV1EntityType"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1EntityType"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"readFeatureValues": {
+"description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues",
+"parameterOrder": [
+"entityType"
+],
+"parameters": {
+"entityType": {
+"description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+entityType}:readFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -5958,9 +13322,9 @@
 },
 "setIamPolicy": {
 "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.setIamPolicy",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy",
 "parameterOrder": [
 "resource"
 ],
@@ -5968,7 +13332,7 @@
 "resource": {
 "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5984,11 +13348,39 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"streamingReadFeatureValues": {
+"description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues",
+"parameterOrder": [
+"entityType"
+],
+"parameters": {
+"entityType": {
+"description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+entityType}:streamingReadFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "testIamPermissions": {
 "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.testIamPermissions",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions",
 "parameterOrder": [
 "resource"
 ],
@@ -6002,7 +13394,7 @@
 "resource": {
 "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6014,16 +13406,44 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"writeFeatureValues": {
+"description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues",
+"parameterOrder": [
+"entityType"
+],
+"parameters": {
+"entityType": {
+"description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+entityType}:writeFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1WriteFeatureValuesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1WriteFeatureValuesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
 "features": {
 "methods": {
 "batchCreate": {
-"description": "Creates a batch of Features in a given FeatureGroup.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate",
+"description": "Creates a batch of Features in a given EntityType.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.features.batchCreate",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate",
 "parameterOrder": [
 "parent"
 ],
@@ -6031,7 +13451,7 @@
 "parent": {
 "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6048,10 +13468,10 @@
 ]
 },
 "create": {
-"description": "Creates a new Feature in a given FeatureGroup.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
+"description": "Creates a new Feature in a given EntityType.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.features.create",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.create",
 "parameterOrder": [
 "parent"
 ],
@@ -6064,7 +13484,7 @@
 "parent": {
 "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6082,9 +13502,9 @@
 },
 "delete": {
 "description": "Deletes a single Feature.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.features.delete",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6092,7 +13512,7 @@
 "name": {
 "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6107,9 +13527,9 @@
 },
 "get": {
 "description": "Gets details of a single Feature.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.get",
 "parameterOrder": [
 "name"
 ],
@@ -6117,7 +13537,7 @@
 "name": {
 "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6131,10 +13551,10 @@
 ]
 },
 "list": {
-"description": "Lists Features in a given FeatureGroup.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
+"description": "Lists Features in a given EntityType.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.list",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.list",
 "parameterOrder": [
 "parent"
 ],
@@ -6169,7 +13589,7 @@
 "parent": {
 "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6190,9 +13610,9 @@
 },
 "patch": {
 "description": "Updates the parameters of a single Feature.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureGroups.features.patch",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch",
 "parameterOrder": [
 "name"
 ],
@@ -6200,7 +13620,7 @@
 "name": {
 "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6216,7 +13636,7 @@
 "$ref": "GoogleCloudAiplatformV1Feature"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Feature"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -6226,11 +13646,36 @@
 "resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.delete",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6238,7 +13683,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6253,9 +13698,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6263,7 +13708,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6276,11 +13721,11 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listWait": {
+"list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.listWait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -6293,7 +13738,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6314,7 +13759,7 @@
 "type": "boolean"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}/operations",
 "response": {
 "$ref": "GoogleLongrunningListOperationsResponse"
 },
@@ -6324,9 +13769,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.wait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6334,7 +13779,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6359,11 +13804,36 @@
 },
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.operations.delete",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6371,7 +13841,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6386,9 +13856,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.operations.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6396,7 +13866,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6409,11 +13879,11 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listWait": {
+"list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.operations.listWait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -6426,7 +13896,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6447,7 +13917,7 @@
 "type": "boolean"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}/operations",
 "response": {
 "$ref": "GoogleLongrunningListOperationsResponse"
 },
@@ -6457,9 +13927,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.operations.wait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6467,7 +13937,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6490,321 +13960,235 @@
 }
 }
 },
-"featureOnlineStores": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a new FeatureOnlineStore in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"featureOnlineStoreId": {
-"description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/featureOnlineStores",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.delete",
+"id": "aiplatform.projects.locations.featurestores.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single FeatureOnlineStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.get",
+"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/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featurestores.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureOnlineStore resource.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy",
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featurestores.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:getIamPolicy",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists FeatureOnlineStores in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.list",
+"id": "aiplatform.projects.locations.featurestores.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/featureOnlineStores",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListFeatureOnlineStoresResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the parameters of a single FeatureOnlineStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureOnlineStores.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FeatureOnlineStore"
-},
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy",
+"hyperparameterTuningJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:setIamPolicy",
+"path": "v1/{+name}:cancel",
 "request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
-"response": {
-"$ref": "GoogleIamV1Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
-"required": true,
-"type": "string"
-}
+"$ref": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest"
 },
-"path": "v1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"featureViews": {
-"methods": {
 "create": {
-"description": "Creates a new FeatureView in a given FeatureOnlineStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
+"description": "Creates a HyperparameterTuningJob",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"featureViewId": {
-"description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"runSyncImmediately": {
-"description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1/{+parent}/featureViews",
+"path": "v1/{+parent}/hyperparameterTuningJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1FeatureView"
+"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a single FeatureView.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"description": "Deletes a HyperparameterTuningJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6817,558 +14201,573 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"directWrite": {
-"description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite",
+"get": {
+"description": "Gets a HyperparameterTuningJob",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.get",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"name": {
+"description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+featureView}:directWrite",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1FeatureViewDirectWriteResponse"
+"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchFeatureValues": {
-"description": "Fetch feature values under a FeatureView.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues",
+"list": {
+"description": "Lists HyperparameterTuningJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.list",
 "parameterOrder": [
-"featureView"
+"parent"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+featureView}:fetchFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesRequest"
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+parent}/hyperparameterTuningJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1FetchFeatureValuesResponse"
+"$ref": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"generateFetchAccessToken": {
-"description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+featureView}:generateFetchAccessToken",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateFetchAccessTokenResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single FeatureView.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get",
+"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/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1FeatureView"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:getIamPolicy",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists FeatureViews in a given FeatureOnlineStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/featureViews",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListFeatureViewsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the parameters of a single FeatureView.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FeatureView"
-},
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"searchNearestEntities": {
-"description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities",
+"indexEndpoints": {
+"methods": {
+"create": {
+"description": "Creates an IndexEndpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities",
+"id": "aiplatform.projects.locations.indexEndpoints.create",
 "parameterOrder": [
-"featureView"
+"parent"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"parent": {
+"description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+featureView}:searchNearestEntities",
+"path": "v1/{+parent}/indexEndpoints",
 "request": {
-"$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesRequest"
+"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1SearchNearestEntitiesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy",
+"delete": {
+"description": "Deletes an IndexEndpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.indexEndpoints.delete",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"sync": {
-"description": "Triggers on-demand sync for the FeatureView.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync",
+"deployIndex": {
+"description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync",
+"id": "aiplatform.projects.locations.indexEndpoints.deployIndex",
 "parameterOrder": [
-"featureView"
+"indexEndpoint"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"indexEndpoint": {
+"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+featureView}:sync",
+"path": "v1/{+indexEndpoint}:deployIndex",
 "request": {
-"$ref": "GoogleCloudAiplatformV1SyncFeatureViewRequest"
+"$ref": "GoogleCloudAiplatformV1DeployIndexRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1SyncFeatureViewResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions",
+"findNeighbors": {
+"description": "Finds the nearest neighbors of each vector within the request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions",
+"id": "aiplatform.projects.locations.indexEndpoints.findNeighbors",
 "parameterOrder": [
-"resource"
+"indexEndpoint"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"indexEndpoint": {
+"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:testIamPermissions",
+"path": "v1/{+indexEndpoint}:findNeighbors",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FindNeighborsRequest"
+},
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleCloudAiplatformV1FindNeighborsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"featureViewSyncs": {
-"methods": {
 "get": {
-"description": "Gets details of a single FeatureViewSync.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}",
+"description": "Gets an IndexEndpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get",
+"id": "aiplatform.projects.locations.indexEndpoints.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`",
+"description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1FeatureViewSync"
+"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists FeatureViewSyncs in a given FeatureView.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs",
+"description": "Lists IndexEndpoints in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list",
+"id": "aiplatform.projects.locations.indexEndpoints.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`",
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.",
+"description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/featureViewSyncs",
+"path": "v1/{+parent}/indexEndpoints",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListFeatureViewSyncsResponse"
+"$ref": "GoogleCloudAiplatformV1ListIndexEndpointsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"operations": {
-"methods": {
-"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/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete",
+"mutateDeployedIndex": {
+"description": "Update an existing DeployedIndex under an IndexEndpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex",
 "parameterOrder": [
-"name"
+"indexEndpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"indexEndpoint": {
+"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+indexEndpoint}:mutateDeployedIndex",
+"request": {
+"$ref": "GoogleCloudAiplatformV1DeployedIndex"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get",
+"patch": {
+"description": "Updates an IndexEndpoint.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.indexEndpoints.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Output only. The resource name of the IndexEndpoint.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listWait": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait",
+"readIndexDatapoints": {
+"description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints",
 "parameterOrder": [
-"name"
+"indexEndpoint"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
+"indexEndpoint": {
+"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"path": "v1/{+indexEndpoint}:readIndexDatapoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest"
 },
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
+"response": {
+"$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"undeployIndex": {
+"description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexEndpoints.undeployIndex",
+"parameterOrder": [
+"indexEndpoint"
+],
+"parameters": {
+"indexEndpoint": {
+"description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+indexEndpoint}:undeployIndex",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UndeployIndexRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"operations": {
-"methods": {
 "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/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.delete",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -7376,7 +14775,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7391,9 +14790,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.get",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -7401,7 +14800,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7414,11 +14813,11 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listWait": {
+"list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.listWait",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -7431,7 +14830,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7452,7 +14851,7 @@
 "type": "boolean"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}/operations",
 "response": {
 "$ref": "GoogleLongrunningListOperationsResponse"
 },
@@ -7462,9 +14861,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.wait",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -7472,7 +14871,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7495,61 +14894,28 @@
 }
 }
 },
-"featurestores": {
+"indexes": {
 "methods": {
-"batchReadFeatureValues": {
-"description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues",
-"parameterOrder": [
-"featurestore"
-],
-"parameters": {
-"featurestore": {
-"description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+featurestore}:batchReadFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchReadFeatureValuesRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "create": {
-"description": "Creates a new Featurestore in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores",
+"description": "Creates an Index.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.create",
+"id": "aiplatform.projects.locations.indexes.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"featurestoreId": {
-"description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/featurestores",
+"path": "v1/{+parent}/indexes",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Featurestore"
+"$ref": "GoogleCloudAiplatformV1Index"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -7559,23 +14925,18 @@
 ]
 },
 "delete": {
-"description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
+"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.delete",
+"id": "aiplatform.projects.locations.indexes.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7589,93 +14950,57 @@
 ]
 },
 "get": {
-"description": "Gets details of a single Featurestore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
+"description": "Gets an Index.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.get",
+"id": "aiplatform.projects.locations.indexes.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Featurestore resource.",
+"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Featurestore"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1Index"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Featurestores in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores",
+"description": "Lists Indexes in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.list",
+"id": "aiplatform.projects.locations.indexes.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.",
+"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -7688,32 +15013,32 @@
 "type": "string"
 }
 },
-"path": "v1/{+parent}/featurestores",
+"path": "v1/{+parent}/indexes",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListFeaturestoresResponse"
+"$ref": "GoogleCloudAiplatformV1ListIndexesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates the parameters of a single Featurestore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
+"description": "Updates an Index.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featurestores.patch",
+"id": "aiplatform.projects.locations.indexes.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "Output only. The resource name of the Index.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`",
+"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -7721,7 +15046,7 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Featurestore"
+"$ref": "GoogleCloudAiplatformV1Index"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -7730,135 +15055,249 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"searchFeatures": {
-"description": "Searches Features matching a query in a given project.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.searchFeatures",
+"removeDatapoints": {
+"description": "Remove Datapoints from an Index.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexes.removeDatapoints",
 "parameterOrder": [
-"location"
+"index"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`",
+"index": {
+"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"pageSize": {
-"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"path": "v1/{+index}:removeDatapoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest"
 },
-"pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.",
-"location": "query",
-"type": "string"
+"response": {
+"$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse"
 },
-"query": {
-"description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.",
-"location": "query",
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"upsertDatapoints": {
+"description": "Add/update Datapoints into an Index.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexes.upsertDatapoints",
+"parameterOrder": [
+"index"
+],
+"parameters": {
+"index": {
+"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1/{+location}/featurestores:searchFeatures",
+"path": "v1/{+index}:upsertDatapoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1SearchFeaturesResponse"
+"$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.setIamPolicy",
+"id": "aiplatform.projects.locations.indexes.operations.cancel",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.indexes.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.indexes.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.indexes.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.testIamPermissions",
+"id": "aiplatform.projects.locations.indexes.operations.wait",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+resource}:testIamPermissions",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"entityTypes": {
+"metadataStores": {
 "methods": {
 "create": {
-"description": "Creates a new EntityType in a given Featurestore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
+"description": "Initializes a MetadataStore, including allocation of resources.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.create",
+"id": "aiplatform.projects.locations.metadataStores.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"entityTypeId": {
-"description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.",
+"metadataStoreId": {
+"description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/entityTypes",
+"path": "v1/{+parent}/metadataStores",
 "request": {
-"$ref": "GoogleCloudAiplatformV1EntityType"
+"$ref": "GoogleCloudAiplatformV1MetadataStore"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -7868,23 +15307,24 @@
 ]
 },
 "delete": {
-"description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
+"description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.delete",
+"id": "aiplatform.projects.locations.metadataStores.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "force": {
-"description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)",
+"deprecated": true,
+"description": "Deprecated: Field is no longer supported.",
 "location": "query",
 "type": "boolean"
 },
 "name": {
-"description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
+"description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7897,216 +15337,228 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deleteFeatureValues": {
-"description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues",
+"get": {
+"description": "Retrieves a specific MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.get",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
+"name": {
+"description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+entityType}:deleteFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DeleteFeatureValuesRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1MetadataStore"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"exportFeatureValues": {
-"description": "Exports Feature values from all the entities of a target EntityType.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues",
+"list": {
+"description": "Lists MetadataStores for a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.list",
 "parameterOrder": [
-"entityType"
+"parent"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
+"pageSize": {
+"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+entityType}:exportFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ExportFeatureValuesRequest"
-},
+"path": "v1/{+parent}/metadataStores",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListMetadataStoresResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"get": {
-"description": "Gets details of a single EntityType.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.get",
+"resources": {
+"artifacts": {
+"methods": {
+"create": {
+"description": "Creates an Artifact associated with a MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
+"artifactId": {
+"description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/artifacts",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Artifact"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1EntityType"
+"$ref": "GoogleCloudAiplatformV1Artifact"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy",
+"delete": {
+"description": "Deletes an Artifact.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.delete",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
+"etag": {
+"description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
 "location": "query",
-"type": "integer"
+"type": "string"
 },
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:getIamPolicy",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"importFeatureValues": {
-"description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues",
+"get": {
+"description": "Retrieves a specific Artifact.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.get",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
+"name": {
+"description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+entityType}:importFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ImportFeatureValuesRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Artifact"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists EntityTypes in a given Featurestore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
+"description": "Lists Artifacts in the MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.list",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.",
+"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`",
+"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.",
+"description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/entityTypes",
+"path": "v1/{+parent}/artifacts",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListEntityTypesResponse"
+"$ref": "GoogleCloudAiplatformV1ListArtifactsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates the parameters of a single EntityType.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
+"description": "Updates a stored Artifact.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.patch",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"allowMissing": {
+"description": "If set to true, and the Artifact is not found, a new Artifact is created.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.",
+"description": "Output only. The resource name of the Artifact.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`",
+"description": "Optional. A FieldMask indicating which fields should be updated.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -8114,236 +15566,353 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1EntityType"
+"$ref": "GoogleCloudAiplatformV1Artifact"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1EntityType"
+"$ref": "GoogleCloudAiplatformV1Artifact"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"readFeatureValues": {
-"description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues",
+"purge": {
+"description": "Purges Artifacts.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.purge",
 "parameterOrder": [
-"entityType"
+"parent"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"parent": {
+"description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+entityType}:readFeatureValues",
+"path": "v1/{+parent}/artifacts:purge",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesRequest"
+"$ref": "GoogleCloudAiplatformV1PurgeArtifactsRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy",
+"queryArtifactLineageSubgraph": {
+"description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph",
 "parameterOrder": [
-"resource"
+"artifact"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"artifact": {
+"description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"filter": {
+"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"location": "query",
+"type": "string"
+},
+"maxHops": {
+"description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+}
 },
+"path": "v1/{+artifact}:queryArtifactLineageSubgraph",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"streamingReadFeatureValues": {
-"description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+entityType}:streamingReadFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest"
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReadFeatureValuesResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
-"repeated": true,
 "type": "string"
 },
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+resource}:testIamPermissions",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"writeFeatureValues": {
-"description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues",
+"contexts": {
+"methods": {
+"addContextArtifactsAndExecutions": {
+"description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues",
+"id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions",
 "parameterOrder": [
-"entityType"
+"context"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"context": {
+"description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+entityType}:writeFeatureValues",
+"path": "v1/{+context}:addContextArtifactsAndExecutions",
 "request": {
-"$ref": "GoogleCloudAiplatformV1WriteFeatureValuesRequest"
+"$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1WriteFeatureValuesResponse"
+"$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"features": {
-"methods": {
-"batchCreate": {
-"description": "Creates a batch of Features in a given EntityType.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate",
+"addContextChildren": {
+"description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate",
+"id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren",
 "parameterOrder": [
-"parent"
+"context"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"context": {
+"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/features:batchCreate",
+"path": "v1/{+context}:addContextChildren",
 "request": {
-"$ref": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest"
+"$ref": "GoogleCloudAiplatformV1AddContextChildrenRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1AddContextChildrenResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "create": {
-"description": "Creates a new Feature in a given EntityType.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
+"description": "Creates a Context associated with a MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.create",
+"id": "aiplatform.projects.locations.metadataStores.contexts.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"featureId": {
-"description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.",
+"contextId": {
+"description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/features",
+"path": "v1/{+parent}/contexts",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Feature"
+"$ref": "GoogleCloudAiplatformV1Context"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Context"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a single Feature.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
+"description": "Deletes a stored Context.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete",
+"id": "aiplatform.projects.locations.metadataStores.contexts.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"etag": {
+"description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
+"location": "query",
+"type": "string"
+},
+"force": {
+"description": "The force deletion semantics is still undefined. Users should not use this field.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
+"description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8357,106 +15926,99 @@
 ]
 },
 "get": {
-"description": "Gets details of a single Feature.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
+"description": "Retrieves a specific Context.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.get",
+"id": "aiplatform.projects.locations.metadataStores.contexts.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Feature"
+"$ref": "GoogleCloudAiplatformV1Context"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Features in a given EntityType.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
+"description": "Lists Contexts on the MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.list",
+"id": "aiplatform.projects.locations.metadataStores.contexts.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.",
+"description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
 "location": "query",
 "type": "string"
 },
-"latestStatsCount": {
-"description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`",
+"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.",
+"description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/features",
+"path": "v1/{+parent}/contexts",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListFeaturesResponse"
+"$ref": "GoogleCloudAiplatformV1ListContextsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates the parameters of a single Feature.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
+"description": "Updates a stored Context.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch",
+"id": "aiplatform.projects.locations.metadataStores.contexts.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"allowMissing": {
+"description": "If set to true, and the Context is not found, a new Context is created.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
+"description": "Immutable. The resource name of the Context.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)",
+"description": "Optional. A FieldMask indicating which fields should be updated.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -8464,10 +16026,91 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Feature"
+"$ref": "GoogleCloudAiplatformV1Context"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Feature"
+"$ref": "GoogleCloudAiplatformV1Context"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"purge": {
+"description": "Purges Contexts.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.purge",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/contexts:purge",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PurgeContextsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"queryContextLineageSubgraph": {
+"description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph",
+"parameterOrder": [
+"context"
+],
+"parameters": {
+"context": {
+"description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+context}:queryContextLineageSubgraph",
+"response": {
+"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"removeContextChildren": {
+"description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren",
+"parameterOrder": [
+"context"
+],
+"parameters": {
+"context": {
+"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+context}:removeContextChildren",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RemoveContextChildrenRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1RemoveContextChildrenResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -8479,9 +16122,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -8489,7 +16132,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8504,9 +16147,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -8514,7 +16157,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8529,9 +16172,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -8539,7 +16182,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8554,9 +16197,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -8569,7 +16212,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8600,9 +16243,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -8610,7 +16253,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8633,13 +16276,271 @@
 }
 }
 },
+"executions": {
+"methods": {
+"addExecutionEvents": {
+"description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents",
+"parameterOrder": [
+"execution"
+],
+"parameters": {
+"execution": {
+"description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+execution}:addExecutionEvents",
+"request": {
+"$ref": "GoogleCloudAiplatformV1AddExecutionEventsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1AddExecutionEventsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates an Execution associated with a MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"executionId": {
+"description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/executions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Execution"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1Execution"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes an Execution.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.executions.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"etag": {
+"description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Retrieves a specific Execution.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1Execution"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Executions in the MetadataStore.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/executions",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListExecutionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a stored Execution.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.metadataStores.executions.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"allowMissing": {
+"description": "If set to true, and the Execution is not found, a new Execution is created.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Output only. The resource name of the Execution.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. A FieldMask indicating which fields should be updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Execution"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1Execution"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"purge": {
+"description": "Purges Executions.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.purge",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/executions:purge",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PurgeExecutionsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"queryExecutionInputsAndOutputs": {
+"description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs",
+"parameterOrder": [
+"execution"
+],
+"parameters": {
+"execution": {
+"description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+execution}:queryExecutionInputsAndOutputs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -8647,7 +16548,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8662,9 +16563,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -8672,7 +16573,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8687,9 +16588,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -8697,7 +16598,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8712,9 +16613,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -8727,7 +16628,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8758,9 +16659,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -8768,7 +16669,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8791,13 +16692,116 @@
 }
 }
 },
+"metadataSchemas": {
+"methods": {
+"create": {
+"description": "Creates a MetadataSchema.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"metadataSchemaId": {
+"description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/metadataSchemas",
+"request": {
+"$ref": "GoogleCloudAiplatformV1MetadataSchema"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1MetadataSchema"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Retrieves a specific MetadataSchema.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1MetadataSchema"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists MetadataSchemas.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "A query to filter available MetadataSchemas for matching results.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/metadataSchemas",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListMetadataSchemasResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.operations.cancel",
+"id": "aiplatform.projects.locations.metadataStores.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -8805,7 +16809,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8820,9 +16824,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.operations.delete",
+"id": "aiplatform.projects.locations.metadataStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -8830,7 +16834,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8845,9 +16849,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.operations.get",
+"id": "aiplatform.projects.locations.metadataStores.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -8855,7 +16859,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8870,9 +16874,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.operations.list",
+"id": "aiplatform.projects.locations.metadataStores.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -8885,7 +16889,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8916,9 +16920,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.operations.wait",
+"id": "aiplatform.projects.locations.metadataStores.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -8926,7 +16930,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8949,82 +16953,29 @@
 }
 }
 },
-"hyperparameterTuningJobs": {
+"migratableResources": {
 "methods": {
-"cancel": {
-"description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a HyperparameterTuningJob",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
+"batchMigrate": {
+"description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.create",
+"id": "aiplatform.projects.locations.migratableResources.batchMigrate",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/hyperparameterTuningJobs",
+"path": "v1/{+parent}/migratableResources:batchMigrate",
 "request": {
-"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a HyperparameterTuningJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
+"$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest"
 },
-"path": "v1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -9032,73 +16983,29 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a HyperparameterTuningJob",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1HyperparameterTuningJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists HyperparameterTuningJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.list",
+"search": {
+"description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.migratableResources.search",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/hyperparameterTuningJobs",
+"path": "v1/{+parent}/migratableResources:search",
+"request": {
+"$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListHyperparameterTuningJobsResponse"
+"$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -9110,9 +17017,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel",
+"id": "aiplatform.projects.locations.migratableResources.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -9120,7 +17027,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9135,9 +17042,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete",
+"id": "aiplatform.projects.locations.migratableResources.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -9145,7 +17052,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9160,9 +17067,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get",
+"id": "aiplatform.projects.locations.migratableResources.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -9170,7 +17077,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9185,9 +17092,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list",
+"id": "aiplatform.projects.locations.migratableResources.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -9200,7 +17107,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -9231,9 +17138,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait",
+"id": "aiplatform.projects.locations.migratableResources.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -9241,7 +17148,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -9264,49 +17171,49 @@
 }
 }
 },
-"indexEndpoints": {
+"modelDeploymentMonitoringJobs": {
 "methods": {
 "create": {
-"description": "Creates an IndexEndpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
+"description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.create",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/indexEndpoints",
+"path": "v1/{+parent}/modelDeploymentMonitoringJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an IndexEndpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"description": "Deletes a ModelDeploymentMonitoringJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexEndpoints.delete",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9319,154 +17226,104 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deployIndex": {
-"description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.deployIndex",
-"parameterOrder": [
-"indexEndpoint"
-],
-"parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+indexEndpoint}:deployIndex",
-"request": {
-"$ref": "GoogleCloudAiplatformV1DeployIndexRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"findNeighbors": {
-"description": "Finds the nearest neighbors of each vector within the request.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.findNeighbors",
-"parameterOrder": [
-"indexEndpoint"
-],
-"parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+indexEndpoint}:findNeighbors",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FindNeighborsRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1FindNeighborsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "get": {
-"description": "Gets an IndexEndpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"description": "Gets a ModelDeploymentMonitoringJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.get",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists IndexEndpoints in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
+"description": "Lists ModelDeploymentMonitoringJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.list",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
 "readMask": {
-"description": "Optional. Mask specifying which fields to read.",
+"description": "Mask specifying which fields to read",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/indexEndpoints",
+"path": "v1/{+parent}/modelDeploymentMonitoringJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListIndexEndpointsResponse"
+"$ref": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"mutateDeployedIndex": {
-"description": "Update an existing DeployedIndex under an IndexEndpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex",
+"patch": {
+"description": "Updates a ModelDeploymentMonitoringJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch",
 "parameterOrder": [
-"indexEndpoint"
+"name"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"name": {
+"description": "Output only. Resource name of a ModelDeploymentMonitoringJob.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+indexEndpoint}:mutateDeployedIndex",
+"path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1DeployedIndex"
+"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -9475,91 +17332,85 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an IndexEndpoint.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.indexEndpoints.patch",
+"pause": {
+"description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the IndexEndpoint.",
+"description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}:pause",
 "request": {
-"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1IndexEndpoint"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"readIndexDatapoints": {
-"description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints",
+"resume": {
+"description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume",
 "parameterOrder": [
-"indexEndpoint"
+"name"
 ],
-"parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"parameters": {
+"name": {
+"description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+indexEndpoint}:readIndexDatapoints",
+"path": "v1/{+name}:resume",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsRequest"
+"$ref": "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReadIndexDatapointsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"undeployIndex": {
-"description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex",
+"searchModelDeploymentMonitoringStatsAnomalies": {
+"description": "Searches Model Monitoring Statistics generated within a given time window.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.undeployIndex",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies",
 "parameterOrder": [
-"indexEndpoint"
+"modelDeploymentMonitoringJob"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"modelDeploymentMonitoringJob": {
+"description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+indexEndpoint}:undeployIndex",
+"path": "v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies",
 "request": {
-"$ref": "GoogleCloudAiplatformV1UndeployIndexRequest"
+"$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -9571,9 +17422,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.cancel",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -9581,7 +17432,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9596,9 +17447,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.delete",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -9606,7 +17457,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9621,9 +17472,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.get",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -9631,7 +17482,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9646,9 +17497,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.list",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -9661,7 +17512,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -9692,9 +17543,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.wait",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -9702,7 +17553,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -9725,28 +17576,28 @@
 }
 }
 },
-"indexes": {
+"models": {
 "methods": {
-"create": {
-"description": "Creates an Index.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes",
+"copy": {
+"description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:copy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.create",
+"id": "aiplatform.projects.locations.models.copy",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/indexes",
+"path": "v1/{+parent}/models:copy",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Index"
+"$ref": "GoogleCloudAiplatformV1CopyModelRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -9756,18 +17607,18 @@
 ]
 },
 "delete": {
-"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
+"description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexes.delete",
+"id": "aiplatform.projects.locations.models.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9780,42 +17631,131 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"deleteVersion": {
+"description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.models.deleteVersion",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:deleteVersion",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"export": {
+"description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.export",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:export",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ExportModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
-"description": "Gets an Index.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
+"description": "Gets a Model.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.get",
+"id": "aiplatform.projects.locations.models.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Index"
+"$ref": "GoogleCloudAiplatformV1Model"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Indexes in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes",
+"description": "Lists Models in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.list",
+"id": "aiplatform.projects.locations.models.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
 "location": "query",
 "type": "string"
 },
@@ -9826,12 +17766,12 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.",
+"description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -9844,291 +17784,271 @@
 "type": "string"
 }
 },
-"path": "v1/{+parent}/indexes",
+"path": "v1/{+parent}/models",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListIndexesResponse"
+"$ref": "GoogleCloudAiplatformV1ListModelsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an Index.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.indexes.patch",
+"listCheckpoints": {
+"description": "Lists checkpoints of the specified model version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.listCheckpoints",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the Index.",
+"description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
-"format": "google-fieldmask",
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Index"
-},
+"path": "v1/{+name}:listCheckpoints",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"removeDatapoints": {
-"description": "Remove Datapoints from an Index.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.removeDatapoints",
+"listVersions": {
+"description": "Lists versions of the specified model.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.listVersions",
 "parameterOrder": [
-"index"
+"name"
 ],
 "parameters": {
-"index": {
-"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"filter": {
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The name of the model to list versions for.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+index}:removeDatapoints",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest"
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.",
+"location": "query",
+"type": "string"
 },
-"response": {
-"$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageToken": {
+"description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.",
+"location": "query",
+"type": "string"
 },
-"upsertDatapoints": {
-"description": "Add/update Datapoints into an Index.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.upsertDatapoints",
-"parameterOrder": [
-"index"
-],
-"parameters": {
-"index": {
-"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
-"required": true,
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+index}:upsertDatapoints",
-"request": {
-"$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest"
-},
+"path": "v1/{+name}:listVersions",
 "response": {
-"$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse"
+"$ref": "GoogleCloudAiplatformV1ListModelVersionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel",
+"mergeVersionAliases": {
+"description": "Merges a set of aliases for a Model version.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.operations.cancel",
+"id": "aiplatform.projects.locations.models.mergeVersionAliases",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+name}:mergeVersionAliases",
+"request": {
+"$ref": "GoogleCloudAiplatformV1MergeVersionAliasesRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1Model"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexes.operations.delete",
+"patch": {
+"description": "Updates a Model.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.models.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "The resource name of the Model.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Model"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1Model"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.operations.get",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.setIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.operations.list",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.testIamPermissions",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
 "location": "query",
+"repeated": true,
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait",
+"updateExplanationDataset": {
+"description": "Incrementally update the dataset used for an examples model.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.operations.wait",
+"id": "aiplatform.projects.locations.models.updateExplanationDataset",
 "parameterOrder": [
-"name"
+"model"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"model": {
+"description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+model}:updateExplanationDataset",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"metadataStores": {
-"methods": {
-"create": {
-"description": "Initializes a MetadataStore, including allocation of resources.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores",
+"upload": {
+"description": "Uploads a Model artifact into Vertex AI.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:upload",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.create",
+"id": "aiplatform.projects.locations.models.upload",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"metadataStoreId": {
-"description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`",
+"description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/metadataStores",
+"path": "v1/{+parent}/models:upload",
 "request": {
-"$ref": "GoogleCloudAiplatformV1MetadataStore"
+"$ref": "GoogleCloudAiplatformV1UploadModelRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -10136,94 +18056,106 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"delete": {
-"description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.delete",
+"resources": {
+"evaluations": {
+"methods": {
+"get": {
+"description": "Gets a ModelEvaluation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"deprecated": true,
-"description": "Deprecated: Field is no longer supported.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ModelEvaluation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Retrieves a specific MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.get",
+"import": {
+"description": "Imports an externally generated ModelEvaluation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.evaluations.import",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"parent": {
+"description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/evaluations:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ImportModelEvaluationRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1MetadataStore"
+"$ref": "GoogleCloudAiplatformV1ModelEvaluation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists MetadataStores for a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores",
+"description": "Lists ModelEvaluations in a Model.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.list",
+"id": "aiplatform.projects.locations.models.evaluations.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
-"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/metadataStores",
+"path": "v1/{+parent}/evaluations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListMetadataStoresResponse"
+"$ref": "GoogleCloudAiplatformV1ListModelEvaluationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -10231,254 +18163,275 @@
 }
 },
 "resources": {
-"artifacts": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates an Artifact associated with a MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.create",
+"id": "aiplatform.projects.locations.models.evaluations.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"artifactId": {
-"description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/artifacts",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Artifact"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Artifact"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an Artifact.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"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/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.delete",
+"id": "aiplatform.projects.locations.models.evaluations.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"etag": {
-"description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Retrieves a specific Artifact.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.get",
+"id": "aiplatform.projects.locations.models.evaluations.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Artifact"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Artifacts in the MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.list",
+"id": "aiplatform.projects.locations.models.evaluations.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/artifacts",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListArtifactsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a stored Artifact.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.evaluations.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"allowMissing": {
-"description": "If set to true, and the Artifact is not found, a new Artifact is created.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Output only. The resource name of the Artifact.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. A FieldMask indicating which fields should be updated.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Artifact"
-},
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Artifact"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"purge": {
-"description": "Purges Artifacts.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge",
+"slices": {
+"methods": {
+"batchImport": {
+"description": "Imports a list of externally generated EvaluatedAnnotations.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.purge",
+"id": "aiplatform.projects.locations.models.evaluations.slices.batchImport",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/artifacts:purge",
+"path": "v1/{+parent}:batchImport",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PurgeArtifactsRequest"
+"$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"queryArtifactLineageSubgraph": {
-"description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph",
+"get": {
+"description": "Gets a ModelEvaluationSlice.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph",
+"id": "aiplatform.projects.locations.models.evaluations.slices.get",
 "parameterOrder": [
-"artifact"
+"name"
 ],
 "parameters": {
-"artifact": {
-"description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
+"name": {
+"description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
 "required": true,
 "type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
+"list": {
+"description": "Lists ModelEvaluationSlices in a ModelEvaluation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.slices.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
 "filter": {
-"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"description": "The standard list filter. * `slice.dimension` - for =.",
 "location": "query",
 "type": "string"
 },
-"maxHops": {
-"description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.",
+"pageSize": {
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+artifact}:queryArtifactLineageSubgraph",
+"path": "v1/{+parent}/slices",
 "response": {
-"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
+"$ref": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel",
+"id": "aiplatform.projects.locations.models.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -10486,7 +18439,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -10501,9 +18454,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete",
+"id": "aiplatform.projects.locations.models.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -10511,7 +18464,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -10526,9 +18479,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get",
+"id": "aiplatform.projects.locations.models.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -10536,7 +18489,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -10551,9 +18504,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list",
+"id": "aiplatform.projects.locations.models.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -10566,7 +18519,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -10597,9 +18550,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait",
+"id": "aiplatform.projects.locations.models.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -10607,7 +18560,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -10630,263 +18583,284 @@
 }
 }
 },
-"contexts": {
+"nasJobs": {
 "methods": {
-"addContextArtifactsAndExecutions": {
-"description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions",
+"cancel": {
+"description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions",
+"id": "aiplatform.projects.locations.nasJobs.cancel",
 "parameterOrder": [
-"context"
+"name"
 ],
 "parameters": {
-"context": {
-"description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"name": {
+"description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+context}:addContextArtifactsAndExecutions",
+"path": "v1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest"
+"$ref": "GoogleCloudAiplatformV1CancelNasJobRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"addContextChildren": {
-"description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren",
+"create": {
+"description": "Creates a NasJob",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren",
+"id": "aiplatform.projects.locations.nasJobs.create",
 "parameterOrder": [
-"context"
+"parent"
 ],
 "parameters": {
-"context": {
-"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"parent": {
+"description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+context}:addContextChildren",
+"path": "v1/{+parent}/nasJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1AddContextChildrenRequest"
+"$ref": "GoogleCloudAiplatformV1NasJob"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1AddContextChildrenResponse"
+"$ref": "GoogleCloudAiplatformV1NasJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a Context associated with a MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.create",
+"delete": {
+"description": "Deletes a NasJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.nasJobs.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"contextId": {
-"description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"name": {
+"description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/contexts",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Context"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Context"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a stored Context.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.contexts.delete",
+"get": {
+"description": "Gets a NasJob",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.nasJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"etag": {
-"description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
+"name": {
+"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1NasJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"list": {
+"description": "Lists NasJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.nasJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
-"force": {
-"description": "The force deletion semantics is still undefined. Users should not use this field.",
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
 "location": "query",
-"type": "boolean"
+"type": "integer"
 },
-"name": {
-"description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/nasJobs",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListNasJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
+"resources": {
+"nasTrialDetails": {
+"methods": {
 "get": {
-"description": "Retrieves a specific Context.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
+"description": "Gets a NasTrialDetail.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.get",
+"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Context"
+"$ref": "GoogleCloudAiplatformV1NasTrialDetail"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Contexts on the MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
+"description": "List top NasTrialDetails of a NasJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.list",
+"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
-"location": "query",
-"type": "string"
-},
 "pageSize": {
-"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/contexts",
+"path": "v1/{+parent}/nasTrialDetails",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListContextsResponse"
+"$ref": "GoogleCloudAiplatformV1ListNasTrialDetailsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"patch": {
-"description": "Updates a stored Context.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.metadataStores.contexts.patch",
+"notebookExecutionJobs": {
+"methods": {
+"create": {
+"description": "Creates a NotebookExecutionJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"allowMissing": {
-"description": "If set to true, and the Context is not found, a new Context is created.",
-"location": "query",
-"type": "boolean"
-},
-"name": {
-"description": "Immutable. The resource name of the Context.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Optional. A FieldMask indicating which fields should be updated.",
-"format": "google-fieldmask",
+"notebookExecutionJobId": {
+"description": "Optional. User specified ID for the NotebookExecutionJob.",
 "location": "query",
 "type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/notebookExecutionJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Context"
+"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Context"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"purge": {
-"description": "Purges Contexts.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.purge",
+"delete": {
+"description": "Deletes a NotebookExecutionJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"name": {
+"description": "Required. The name of the NotebookExecutionJob resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/contexts:purge",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PurgeContextsRequest"
-},
+"path": "v1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -10894,54 +18868,102 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"queryContextLineageSubgraph": {
-"description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph",
+"get": {
+"description": "Gets a NotebookExecutionJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.get",
 "parameterOrder": [
-"context"
+"name"
 ],
 "parameters": {
-"context": {
-"description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
+"name": {
+"description": "Required. The name of the NotebookExecutionJob resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"view": {
+"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
+"enum": [
+"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
+"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
+"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
+],
+"enumDescriptions": [
+"When unspecified, the API defaults to the BASIC view.",
+"Includes all fields except for direct notebook inputs.",
+"Includes all fields."
+],
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+context}:queryContextLineageSubgraph",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
+"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"removeContextChildren": {
-"description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren",
+"list": {
+"description": "Lists NotebookExecutionJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.list",
 "parameterOrder": [
-"context"
+"parent"
 ],
 "parameters": {
-"context": {
-"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+context}:removeContextChildren",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RemoveContextChildrenRequest"
+"view": {
+"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
+"enum": [
+"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
+"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
+"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
+],
+"enumDescriptions": [
+"When unspecified, the API defaults to the BASIC view.",
+"Includes all fields except for direct notebook inputs.",
+"Includes all fields."
+],
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+parent}/notebookExecutionJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1RemoveContextChildrenResponse"
+"$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -10953,9 +18975,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -10963,7 +18985,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -10978,9 +19000,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -10988,7 +19010,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11003,9 +19025,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.get",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -11013,7 +19035,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11028,9 +19050,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.list",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -11043,7 +19065,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11074,9 +19096,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -11084,7 +19106,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11107,87 +19129,54 @@
 }
 }
 },
-"executions": {
+"notebookRuntimeTemplates": {
 "methods": {
-"addExecutionEvents": {
-"description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents",
-"parameterOrder": [
-"execution"
-],
-"parameters": {
-"execution": {
-"description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+execution}:addExecutionEvents",
-"request": {
-"$ref": "GoogleCloudAiplatformV1AddExecutionEventsRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1AddExecutionEventsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "create": {
-"description": "Creates an Execution associated with a MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"description": "Creates a NotebookRuntimeTemplate.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.create",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"executionId": {
-"description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)",
+"notebookRuntimeTemplateId": {
+"description": "Optional. User specified ID for the notebook runtime template.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/executions",
+"path": "v1/{+parent}/notebookRuntimeTemplates",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Execution"
+"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Execution"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an Execution.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"description": "Deletes a NotebookRuntimeTemplate.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.executions.delete",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"etag": {
-"description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11201,99 +19190,131 @@
 ]
 },
 "get": {
-"description": "Retrieves a specific Execution.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"description": "Gets a NotebookRuntimeTemplate.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.get",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Execution"
+"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Executions in the MetadataStore.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"description": "Lists NotebookRuntimeTemplates in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.list",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)",
+"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/executions",
+"path": "v1/{+parent}/notebookRuntimeTemplates",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListExecutionsResponse"
+"$ref": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a stored Execution.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"description": "Updates a NotebookRuntimeTemplate.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.metadataStores.executions.patch",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"allowMissing": {
-"description": "If set to true, and the Execution is not found, a new Execution is created.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Output only. The resource name of the Execution.",
+"description": "The resource name of the NotebookRuntimeTemplate.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. A FieldMask indicating which fields should be updated.",
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -11301,63 +19322,69 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Execution"
+"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Execution"
+"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"purge": {
-"description": "Purges Executions.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.purge",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy",
 "parameterOrder": [
-"parent"
+"resource"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/executions:purge",
+"path": "v1/{+resource}:setIamPolicy",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PurgeExecutionsRequest"
+"$ref": "GoogleIamV1SetIamPolicyRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"queryExecutionInputsAndOutputs": {
-"description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions",
 "parameterOrder": [
-"execution"
+"resource"
 ],
 "parameters": {
-"execution": {
-"description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+execution}:queryExecutionInputsAndOutputs",
+"path": "v1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleCloudAiplatformV1LineageSubgraph"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -11369,9 +19396,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -11379,7 +19406,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11394,9 +19421,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.delete",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -11404,7 +19431,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11419,9 +19446,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.get",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -11429,7 +19456,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11444,9 +19471,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.list",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -11459,7 +19486,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11490,149 +19517,264 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.wait",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookRuntimes": {
+"methods": {
+"assign": {
+"description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.assign",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/notebookRuntimes:assign",
+"request": {
+"$ref": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a NotebookRuntime.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookRuntimes.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a NotebookRuntime.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimes.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1NotebookRuntime"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists NotebookRuntimes in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimes.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+parent}/notebookRuntimes",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"metadataSchemas": {
-"methods": {
-"create": {
-"description": "Creates a MetadataSchema.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"start": {
+"description": "Starts a NotebookRuntime.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create",
+"id": "aiplatform.projects.locations.notebookRuntimes.start",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"metadataSchemaId": {
-"description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/metadataSchemas",
+"path": "v1/{+name}:start",
 "request": {
-"$ref": "GoogleCloudAiplatformV1MetadataSchema"
+"$ref": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1MetadataSchema"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Retrieves a specific MetadataSchema.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get",
+"stop": {
+"description": "Stops a NotebookRuntime.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.stop",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`",
+"description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}:stop",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1MetadataSchema"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists MetadataSchemas.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list",
+"upgrade": {
+"description": "Upgrades a NotebookRuntime.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.upgrade",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "A query to filter available MetadataSchemas for matching results.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/metadataSchemas",
+"path": "v1/{+name}:upgrade",
+"request": {
+"$ref": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListMetadataSchemasResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
 },
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.operations.cancel",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -11640,7 +19782,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11655,9 +19797,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.operations.delete",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -11665,7 +19807,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11680,9 +19822,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.operations.get",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -11690,7 +19832,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11705,9 +19847,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.operations.list",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -11720,7 +19862,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11751,9 +19893,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.operations.wait",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -11761,7 +19903,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11784,73 +19926,13 @@
 }
 }
 },
-"migratableResources": {
-"methods": {
-"batchMigrate": {
-"description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.batchMigrate",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/migratableResources:batchMigrate",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchMigrateResourcesRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"search": {
-"description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources:search",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.search",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/migratableResources:search",
-"request": {
-"$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1SearchMigratableResourcesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.operations.cancel",
+"id": "aiplatform.projects.locations.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -11858,7 +19940,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11873,9 +19955,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.migratableResources.operations.delete",
+"id": "aiplatform.projects.locations.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -11883,7 +19965,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11898,9 +19980,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.migratableResources.operations.get",
+"id": "aiplatform.projects.locations.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -11908,7 +19990,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11923,9 +20005,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.migratableResources.operations.list",
+"id": "aiplatform.projects.locations.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -11938,7 +20020,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11969,9 +20051,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.operations.wait",
+"id": "aiplatform.projects.locations.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -11979,7 +20061,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11999,52 +20081,55 @@
 ]
 }
 }
-}
-}
 },
-"modelDeploymentMonitoringJobs": {
+"persistentResources": {
 "methods": {
 "create": {
-"description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
+"description": "Creates a PersistentResource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create",
+"id": "aiplatform.projects.locations.persistentResources.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"persistentResourceId": {
+"description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/modelDeploymentMonitoringJobs",
+"path": "v1/{+parent}/persistentResources",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1PersistentResource"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a ModelDeploymentMonitoringJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"description": "Deletes a PersistentResource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete",
+"id": "aiplatform.projects.locations.persistentResources.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12058,95 +20143,84 @@
 ]
 },
 "get": {
-"description": "Gets a ModelDeploymentMonitoringJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"description": "Gets a PersistentResource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get",
+"id": "aiplatform.projects.locations.persistentResources.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1PersistentResource"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists ModelDeploymentMonitoringJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
+"description": "Lists PersistentResources in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list",
+"id": "aiplatform.projects.locations.persistentResources.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
-"location": "query",
-"type": "string"
-},
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/modelDeploymentMonitoringJobs",
+"path": "v1/{+parent}/persistentResources",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListModelDeploymentMonitoringJobsResponse"
+"$ref": "GoogleCloudAiplatformV1ListPersistentResourcesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a ModelDeploymentMonitoringJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"description": "Updates a PersistentResource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch",
+"id": "aiplatform.projects.locations.persistentResources.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Resource name of a ModelDeploymentMonitoringJob.",
+"description": "Immutable. Resource name of a PersistentResource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`",
+"description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -12154,7 +20228,7 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ModelDeploymentMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1PersistentResource"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -12163,85 +20237,29 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"pause": {
-"description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:pause",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"resume": {
-"description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume",
+"reboot": {
+"description": "Reboots a PersistentResource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume",
+"id": "aiplatform.projects.locations.persistentResources.reboot",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:resume",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"searchModelDeploymentMonitoringStatsAnomalies": {
-"description": "Searches Model Monitoring Statistics generated within a given time window.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies",
-"parameterOrder": [
-"modelDeploymentMonitoringJob"
-],
-"parameters": {
-"modelDeploymentMonitoringJob": {
-"description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies",
+"path": "v1/{+name}:reboot",
 "request": {
-"$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest"
+"$ref": "GoogleCloudAiplatformV1RebootPersistentResourceRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -12253,9 +20271,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel",
+"id": "aiplatform.projects.locations.persistentResources.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -12263,7 +20281,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12278,9 +20296,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete",
+"id": "aiplatform.projects.locations.persistentResources.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -12288,7 +20306,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12303,9 +20321,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get",
+"id": "aiplatform.projects.locations.persistentResources.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -12313,7 +20331,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12328,9 +20346,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list",
+"id": "aiplatform.projects.locations.persistentResources.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -12343,7 +20361,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -12374,9 +20392,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait",
+"id": "aiplatform.projects.locations.persistentResources.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -12384,7 +20402,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -12407,28 +20425,28 @@
 }
 }
 },
-"models": {
+"pipelineJobs": {
 "methods": {
-"copy": {
-"description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:copy",
+"batchCancel": {
+"description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.copy",
+"id": "aiplatform.projects.locations.pipelineJobs.batchCancel",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/models:copy",
+"path": "v1/{+parent}/pipelineJobs:batchCancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CopyModelRequest"
+"$ref": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -12437,24 +20455,27 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.delete",
+"batchDelete": {
+"description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.batchDelete",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`",
+"parent": {
+"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/pipelineJobs:batchDelete",
+"request": {
+"$ref": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -12462,131 +20483,133 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deleteVersion": {
-"description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.deleteVersion",
+"cancel": {
+"description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:deleteVersion",
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CancelPipelineJobRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"export": {
-"description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export",
+"create": {
+"description": "Creates a PipelineJob. A PipelineJob will run immediately when created.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.export",
+"id": "aiplatform.projects.locations.pipelineJobs.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.",
+"parent": {
+"description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pipelineJobId": {
+"description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+name}:export",
+"path": "v1/{+parent}/pipelineJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ExportModelRequest"
+"$ref": "GoogleCloudAiplatformV1PipelineJob"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1PipelineJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a Model.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.get",
+"delete": {
+"description": "Deletes a PipelineJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.pipelineJobs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.",
+"description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Model"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.getIamPolicy",
+"get": {
+"description": "Gets a PipelineJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:getIamPolicy",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1PipelineJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Models in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models",
+"description": "Lists PipelineJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.list",
+"id": "aiplatform.projects.locations.pipelineJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`",
 "location": "query",
 "type": "string"
 },
@@ -12597,12 +20620,12 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.",
+"description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -12615,654 +20638,657 @@
 "type": "string"
 }
 },
-"path": "v1/{+parent}/models",
+"path": "v1/{+parent}/pipelineJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListModelsResponse"
+"$ref": "GoogleCloudAiplatformV1ListPipelineJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"listCheckpoints": {
-"description": "Lists checkpoints of the specified model version.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.listCheckpoints",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "Optional. The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}:listCheckpoints",
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListModelVersionCheckpointsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listVersions": {
-"description": "Lists versions of the specified model.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.listVersions",
+"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/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The name of the model to list versions for.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.",
-"location": "query",
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}:listVersions",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListModelVersionsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"mergeVersionAliases": {
-"description": "Merges a set of aliases for a Model version.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.mergeVersionAliases",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:mergeVersionAliases",
-"request": {
-"$ref": "GoogleCloudAiplatformV1MergeVersionAliasesRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Model"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a Model.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.models.patch",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "The resource name of the Model.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
-"format": "google-fieldmask",
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
-}
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Model"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Model"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.setIamPolicy",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.wait",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions",
+"publishers": {
+"resources": {
+"models": {
+"methods": {
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.testIamPermissions",
+"id": "aiplatform.projects.locations.publishers.models.computeTokens",
 "parameterOrder": [
-"resource"
+"endpoint"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:testIamPermissions",
+"path": "v1/{+endpoint}:computeTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
+},
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"updateExplanationDataset": {
-"description": "Incrementally update the dataset used for an examples model.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset",
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.updateExplanationDataset",
+"id": "aiplatform.projects.locations.publishers.models.countTokens",
 "parameterOrder": [
-"model"
+"endpoint"
 ],
 "parameters": {
-"model": {
-"description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:updateExplanationDataset",
+"path": "v1/{+endpoint}:countTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1UpdateExplanationDatasetRequest"
+"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"upload": {
-"description": "Uploads a Model artifact into Vertex AI.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models:upload",
+"embedContent": {
+"description": "Embed content with multimodal inputs.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.upload",
+"id": "aiplatform.projects.locations.publishers.models.embedContent",
 "parameterOrder": [
-"parent"
+"model"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`",
+"model": {
+"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/models:upload",
+"path": "v1/{+model}:embedContent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1UploadModelRequest"
+"$ref": "GoogleCloudAiplatformV1EmbedContentRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1EmbedContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
-}
 },
-"resources": {
-"evaluations": {
-"methods": {
-"get": {
-"description": "Gets a ModelEvaluation.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.get",
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ModelEvaluation"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"import": {
-"description": "Imports an externally generated ModelEvaluation.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import",
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.import",
+"id": "aiplatform.projects.locations.publishers.models.generateContent",
 "parameterOrder": [
-"parent"
+"model"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/evaluations:import",
+"path": "v1/{+model}:generateContent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ImportModelEvaluationRequest"
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ModelEvaluation"
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"list": {
-"description": "Lists ModelEvaluations in a Model.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.list",
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.predict",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/evaluations",
+"path": "v1/{+endpoint}:predict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListModelEvaluationsResponse"
+"$ref": "GoogleCloudAiplatformV1PredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel",
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.operations.cancel",
+"id": "aiplatform.projects.locations.publishers.models.predictLongRunning",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"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/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.evaluations.operations.delete",
+"rawPredict": {
+"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.rawPredict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+endpoint}:rawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RawPredictRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.operations.get",
+"serverStreamingPredict": {
+"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+endpoint}:serverStreamingPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamingPredictRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1StreamingPredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.operations.list",
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.streamGenerateContent",
 "parameterOrder": [
-"name"
+"model"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+model}:streamGenerateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait",
+"streamRawPredict": {
+"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.operations.wait",
+"id": "aiplatform.projects.locations.publishers.models.streamRawPredict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+endpoint}:streamRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 }
 }
+}
+}
 },
-"slices": {
+"ragCorpora": {
 "methods": {
-"batchImport": {
-"description": "Imports a list of externally generated EvaluatedAnnotations.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport",
+"create": {
+"description": "Creates a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.slices.batchImport",
+"id": "aiplatform.projects.locations.ragCorpora.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
+"description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}:batchImport",
+"path": "v1/{+parent}/ragCorpora",
 "request": {
-"$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest"
+"$ref": "GoogleCloudAiplatformV1RagCorpus"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsResponse"
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.ragCorpora.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a ModelEvaluationSlice.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}",
+"description": "Gets a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.slices.get",
+"id": "aiplatform.projects.locations.ragCorpora.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
+"description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ModelEvaluationSlice"
+"$ref": "GoogleCloudAiplatformV1RagCorpus"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists ModelEvaluationSlices in a ModelEvaluation.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices",
+"description": "Lists RagCorpora in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.slices.list",
+"id": "aiplatform.projects.locations.ragCorpora.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter. * `slice.dimension` - for =.",
-"location": "query",
-"type": "string"
-},
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.",
+"description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1/{+parent}/ragCorpora",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListRagCorporaResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.ragCorpora.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. The resource name of the RagCorpus.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/slices",
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1RagCorpus"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListModelEvaluationSlicesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
 },
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.operations.cancel",
+"id": "aiplatform.projects.locations.ragCorpora.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -13270,7 +21296,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13285,9 +21311,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.operations.delete",
+"id": "aiplatform.projects.locations.ragCorpora.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -13295,7 +21321,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13310,9 +21336,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.operations.get",
+"id": "aiplatform.projects.locations.ragCorpora.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -13320,7 +21346,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13335,9 +21361,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.operations.list",
+"id": "aiplatform.projects.locations.ragCorpora.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -13350,7 +21376,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13381,9 +21407,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.operations.wait",
+"id": "aiplatform.projects.locations.ragCorpora.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -13391,7 +21417,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13411,80 +21437,27 @@
 ]
 }
 }
-}
-}
 },
-"nasJobs": {
+"ragFiles": {
 "methods": {
-"cancel": {
-"description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.nasJobs.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelNasJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a NasJob",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.nasJobs.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/nasJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1NasJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1NasJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes a NasJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"description": "Deletes a RagFile.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.nasJobs.delete",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"forceDelete": {
+"description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13498,317 +21471,265 @@
 ]
 },
 "get": {
-"description": "Gets a NasJob",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"description": "Gets a RagFile.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.get",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1NasJob"
+"$ref": "GoogleCloudAiplatformV1RagFile"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists NasJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.list",
+"import": {
+"description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.import",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/nasJobs",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ListNasJobsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
-"resources": {
-"nasTrialDetails": {
-"methods": {
-"get": {
-"description": "Gets a NasTrialDetail.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$",
-"required": true,
-"type": "string"
-}
+"path": "v1/{+parent}/ragFiles:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ImportRagFilesRequest"
 },
-"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1NasTrialDetail"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "List top NasTrialDetails of a NasJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails",
+"description": "Lists RagFiles in a RagCorpus.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.",
+"description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/nasTrialDetails",
+"path": "v1/{+parent}/ragFiles",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListNasTrialDetailsResponse"
+"$ref": "GoogleCloudAiplatformV1ListRagFilesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
 },
-"notebookExecutionJobs": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a NotebookExecutionJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.create",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"notebookExecutionJobId": {
-"description": "Optional. User specified ID for the NotebookExecutionJob.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/notebookExecutionJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a NotebookExecutionJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
+"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/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.delete",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookExecutionJob resource to be deleted.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a NotebookExecutionJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.get",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookExecutionJob resource.",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"view": {
-"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
-"enum": [
-"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
-"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
-"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
-],
-"enumDescriptions": [
-"When unspecified, the API defaults to the BASIC view.",
-"Includes all fields except for direct notebook inputs.",
-"Includes all fields."
-],
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists NotebookExecutionJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.list",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"view": {
-"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
-"enum": [
-"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
-"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
-"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
-],
-"enumDescriptions": [
-"When unspecified, the API defaults to the BASIC view.",
-"Includes all fields except for direct notebook inputs.",
-"Includes all fields."
-],
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/notebookExecutionJobs",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
+}
+}
 },
+"ragEngineConfig": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -13816,7 +21737,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13831,9 +21752,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -13841,7 +21762,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13856,9 +21777,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -13866,7 +21787,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13881,9 +21802,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -13896,7 +21817,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
 "required": true,
 "type": "string"
 },
@@ -13927,9 +21848,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -13937,7 +21858,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13960,33 +21881,28 @@
 }
 }
 },
-"notebookRuntimeTemplates": {
+"reasoningEngines": {
 "methods": {
 "create": {
-"description": "Creates a NotebookRuntimeTemplate.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
+"description": "Creates a reasoning engine.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.create",
+"id": "aiplatform.projects.locations.reasoningEngines.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"notebookRuntimeTemplateId": {
-"description": "Optional. User specified ID for the notebook runtime template.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/notebookRuntimeTemplates",
+"path": "v1/{+parent}/reasoningEngines",
 "request": {
-"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
+"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -13996,18 +21912,23 @@
 ]
 },
 "delete": {
-"description": "Deletes a NotebookRuntimeTemplate.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"description": "Deletes a reasoning engine.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete",
+"id": "aiplatform.projects.locations.reasoningEngines.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
+"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14021,77 +21942,41 @@
 ]
 },
 "get": {
-"description": "Gets a NotebookRuntimeTemplate.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"description": "Gets a reasoning engine.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.get",
+"id": "aiplatform.projects.locations.reasoningEngines.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
+"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists NotebookRuntimeTemplates in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
+"description": "Lists reasoning engines in a location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.list",
+"id": "aiplatform.projects.locations.reasoningEngines.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
@@ -14102,50 +21987,44 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/notebookRuntimeTemplates",
+"path": "v1/{+parent}/reasoningEngines",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse"
+"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a NotebookRuntimeTemplate.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"description": "Updates a reasoning engine.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch",
+"id": "aiplatform.projects.locations.reasoningEngines.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The resource name of the NotebookRuntimeTemplate.",
+"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`",
+"description": "Optional. Mask specifying which fields to update.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -14153,69 +22032,66 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
+"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1NotebookRuntimeTemplate"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy",
+"query": {
+"description": "Queries using a reasoning engine.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy",
+"id": "aiplatform.projects.locations.reasoningEngines.query",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:setIamPolicy",
+"path": "v1/{+name}:query",
 "request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest"
 },
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions",
+"streamQuery": {
+"description": "Streams queries using a reasoning engine.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions",
+"id": "aiplatform.projects.locations.reasoningEngines.streamQuery",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+resource}:testIamPermissions",
+"path": "v1/{+name}:streamQuery",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest"
+},
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -14227,9 +22103,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -14237,7 +22113,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14252,9 +22128,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -14262,7 +22138,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14277,9 +22153,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -14287,7 +22163,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14302,9 +22178,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -14317,7 +22193,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14348,9 +22224,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -14358,238 +22234,18 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
 "timeout": {
 "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
 "format": "google-duration",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1/{+name}:wait",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-}
-}
-},
-"notebookRuntimes": {
-"methods": {
-"assign": {
-"description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.assign",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/notebookRuntimes:assign",
-"request": {
-"$ref": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a NotebookRuntime.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimes.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets a NotebookRuntime.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1NotebookRuntime"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists NotebookRuntimes in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1/{+parent}/notebookRuntimes",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"start": {
-"description": "Starts a NotebookRuntime.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.start",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:start",
-"request": {
-"$ref": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"stop": {
-"description": "Stops a NotebookRuntime.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.stop",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:stop",
-"request": {
-"$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"upgrade": {
-"description": "Upgrades a NotebookRuntime.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.upgrade",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:upgrade",
-"request": {
-"$ref": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest"
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -14597,173 +22253,235 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"operations": {
+"schedules": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel",
+"create": {
+"description": "Creates a Schedule.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel",
+"id": "aiplatform.projects.locations.schedules.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"parent": {
+"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+parent}/schedules",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Schedule"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1Schedule"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"description": "Deletes a Schedule.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.delete",
+"id": "aiplatform.projects.locations.schedules.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"description": "Gets a Schedule.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.get",
+"id": "aiplatform.projects.locations.schedules.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Schedule"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations",
+"description": "Lists Schedules in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.list",
+"id": "aiplatform.projects.locations.schedules.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The standard list page size. Default to 100 if not specified.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+parent}/schedules",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1ListSchedulesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.wait",
+"patch": {
+"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.schedules.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Immutable. The resource name of the Schedule.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Schedule"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Schedule"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"pause": {
+"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.pause",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
 }
+},
+"path": "v1/{+name}:pause",
+"request": {
+"$ref": "GoogleCloudAiplatformV1PauseScheduleRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"resume": {
+"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.resume",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
 }
-}
+},
+"path": "v1/{+name}:resume",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.operations.cancel",
+"id": "aiplatform.projects.locations.schedules.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -14771,7 +22489,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14786,9 +22504,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.operations.delete",
+"id": "aiplatform.projects.locations.schedules.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -14796,7 +22514,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14811,9 +22529,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.operations.get",
+"id": "aiplatform.projects.locations.schedules.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -14821,7 +22539,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14836,9 +22554,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.operations.list",
+"id": "aiplatform.projects.locations.schedules.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -14851,7 +22569,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14882,9 +22600,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.operations.wait",
+"id": "aiplatform.projects.locations.schedules.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -14892,7 +22610,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14912,34 +22630,31 @@
 ]
 }
 }
+}
+}
 },
-"persistentResources": {
+"specialistPools": {
 "methods": {
 "create": {
-"description": "Creates a PersistentResource.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources",
+"description": "Creates a SpecialistPool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.create",
+"id": "aiplatform.projects.locations.specialistPools.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"persistentResourceId": {
-"description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/persistentResources",
+"path": "v1/{+parent}/specialistPools",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PersistentResource"
+"$ref": "GoogleCloudAiplatformV1SpecialistPool"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -14949,18 +22664,23 @@
 ]
 },
 "delete": {
-"description": "Deletes a PersistentResource.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"description": "Deletes a SpecialistPool as well as all Specialists in the pool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.persistentResources.delete",
+"id": "aiplatform.projects.locations.specialistPools.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`",
+"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14974,84 +22694,90 @@
 ]
 },
 "get": {
-"description": "Gets a PersistentResource.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"description": "Gets a SpecialistPool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.get",
+"id": "aiplatform.projects.locations.specialistPools.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
+"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1PersistentResource"
+"$ref": "GoogleCloudAiplatformV1SpecialistPool"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists PersistentResources in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources",
+"description": "Lists SpecialistPools in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.list",
+"id": "aiplatform.projects.locations.specialistPools.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.",
+"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read. FieldMask represents a set of",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/persistentResources",
+"path": "v1/{+parent}/specialistPools",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListPersistentResourcesResponse"
+"$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a PersistentResource.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"description": "Updates a SpecialistPool.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.persistentResources.patch",
+"id": "aiplatform.projects.locations.specialistPools.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. Resource name of a PersistentResource.",
+"description": "Required. The resource name of the SpecialistPool.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.",
+"description": "Required. The update mask applies to the resource.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -15059,35 +22785,7 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PersistentResource"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"reboot": {
-"description": "Reboots a PersistentResource.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.reboot",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:reboot",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RebootPersistentResourceRequest"
+"$ref": "GoogleCloudAiplatformV1SpecialistPool"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -15102,9 +22800,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.operations.cancel",
+"id": "aiplatform.projects.locations.specialistPools.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -15112,7 +22810,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15127,9 +22825,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.persistentResources.operations.delete",
+"id": "aiplatform.projects.locations.specialistPools.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -15137,7 +22835,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15152,9 +22850,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.operations.get",
+"id": "aiplatform.projects.locations.specialistPools.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -15162,7 +22860,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15177,9 +22875,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.operations.list",
+"id": "aiplatform.projects.locations.specialistPools.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -15192,7 +22890,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -15223,9 +22921,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.operations.wait",
+"id": "aiplatform.projects.locations.specialistPools.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -15233,7 +22931,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -15256,222 +22954,145 @@
 }
 }
 },
-"pipelineJobs": {
+"studies": {
 "methods": {
-"batchCancel": {
-"description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.batchCancel",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/pipelineJobs:batchCancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"batchDelete": {
-"description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.batchDelete",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/pipelineJobs:batchDelete",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"cancel": {
-"description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelPipelineJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "create": {
-"description": "Creates a PipelineJob. A PipelineJob will run immediately when created.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
+"description": "Creates a Study. A resource name will be generated after creation of the Study.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.create",
+"id": "aiplatform.projects.locations.studies.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pipelineJobId": {
-"description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/pipelineJobs",
+"path": "v1/{+parent}/studies",
 "request": {
-"$ref": "GoogleCloudAiplatformV1PipelineJob"
+"$ref": "GoogleCloudAiplatformV1Study"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1PipelineJob"
+"$ref": "GoogleCloudAiplatformV1Study"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a PipelineJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"description": "Deletes a Study.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.pipelineJobs.delete",
+"id": "aiplatform.projects.locations.studies.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a PipelineJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"description": "Gets a Study by name.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.get",
+"id": "aiplatform.projects.locations.studies.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1PipelineJob"
+"$ref": "GoogleCloudAiplatformV1Study"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists PipelineJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
+"description": "Lists all the studies in a region for an associated project.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.list",
+"id": "aiplatform.projects.locations.studies.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`",
-"location": "query",
-"type": "string"
-},
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.",
+"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/studies",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ListStudiesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"lookup": {
+"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.lookup",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/pipelineJobs",
+"path": "v1/{+parent}/studies:lookup",
+"request": {
+"$ref": "GoogleCloudAiplatformV1LookupStudyRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListPipelineJobsResponse"
+"$ref": "GoogleCloudAiplatformV1Study"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -15483,9 +23104,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.cancel",
+"id": "aiplatform.projects.locations.studies.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -15493,7 +23114,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15508,9 +23129,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.delete",
+"id": "aiplatform.projects.locations.studies.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -15518,7 +23139,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15533,9 +23154,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.get",
+"id": "aiplatform.projects.locations.studies.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -15543,7 +23164,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15558,9 +23179,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.list",
+"id": "aiplatform.projects.locations.studies.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -15573,7 +23194,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -15604,9 +23225,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.wait",
+"id": "aiplatform.projects.locations.studies.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -15614,7 +23235,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -15634,447 +23255,440 @@
 ]
 }
 }
-}
-}
 },
-"publishers": {
-"resources": {
-"models": {
+"trials": {
 "methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens",
+"addTrialMeasurement": {
+"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.computeTokens",
+"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement",
 "parameterOrder": [
-"endpoint"
+"trialName"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"trialName": {
+"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:computeTokens",
+"path": "v1/{+trialName}:addTrialMeasurement",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
+"$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
+"$ref": "GoogleCloudAiplatformV1Trial"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens",
+"checkTrialEarlyStoppingState": {
+"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.countTokens",
+"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState",
 "parameterOrder": [
-"endpoint"
+"trialName"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"trialName": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:countTokens",
+"path": "v1/{+trialName}:checkTrialEarlyStoppingState",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
+"$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
+"complete": {
+"description": "Marks a Trial as complete.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation",
+"id": "aiplatform.projects.locations.studies.trials.complete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:fetchPredictOperation",
+"path": "v1/{+name}:complete",
 "request": {
-"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
+"$ref": "GoogleCloudAiplatformV1CompleteTrialRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Trial"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent",
+"create": {
+"description": "Adds a user provided Trial to a Study.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.generateContent",
+"id": "aiplatform.projects.locations.studies.trials.create",
 "parameterOrder": [
-"model"
+"parent"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"parent": {
+"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:generateContent",
+"path": "v1/{+parent}/trials",
 "request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+"$ref": "GoogleCloudAiplatformV1Trial"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleCloudAiplatformV1Trial"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.predict",
+"delete": {
+"description": "Deletes a Trial.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.studies.trials.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:predict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PredictRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1PredictResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.predictLongRunning",
+"get": {
+"description": "Gets a Trial.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.trials.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:predictLongRunning",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Trial"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"rawPredict": {
-"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.rawPredict",
+"list": {
+"description": "Lists the Trials associated with a Study.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.trials.list",
 "parameterOrder": [
-"endpoint"
+"parent"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"pageSize": {
+"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:rawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RawPredictRequest"
-},
+"path": "v1/{+parent}/trials",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1ListTrialsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"serverStreamingPredict": {
-"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict",
+"listOptimalTrials": {
+"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict",
+"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials",
 "parameterOrder": [
-"endpoint"
+"parent"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"parent": {
+"description": "Required. The name of the Study that the optimal Trial belongs to.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:serverStreamingPredict",
+"path": "v1/{+parent}/trials:listOptimalTrials",
 "request": {
-"$ref": "GoogleCloudAiplatformV1StreamingPredictRequest"
+"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1StreamingPredictResponse"
+"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
+"stop": {
+"description": "Stops a Trial.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.streamGenerateContent",
+"id": "aiplatform.projects.locations.studies.trials.stop",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:streamGenerateContent",
+"path": "v1/{+name}:stop",
 "request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
+"$ref": "GoogleCloudAiplatformV1StopTrialRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleCloudAiplatformV1Trial"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamRawPredict": {
-"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict",
+"suggest": {
+"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.streamRawPredict",
+"id": "aiplatform.projects.locations.studies.trials.suggest",
 "parameterOrder": [
-"endpoint"
+"parent"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"parent": {
+"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:streamRawPredict",
+"path": "v1/{+parent}/trials:suggest",
 "request": {
-"$ref": "GoogleCloudAiplatformV1StreamRawPredictRequest"
+"$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest"
 },
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
 },
-"ragCorpora": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.create",
+"id": "aiplatform.projects.locations.studies.trials.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/ragCorpora",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RagCorpus"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"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/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.delete",
+"id": "aiplatform.projects.locations.studies.trials.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.get",
+"id": "aiplatform.projects.locations.studies.trials.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1RagCorpus"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists RagCorpora in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.list",
+"id": "aiplatform.projects.locations.studies.trials.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/ragCorpora",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListRagCorporaResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.ragCorpora.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the RagCorpus.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RagCorpus"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -16082,456 +23696,501 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
+}
+}
 },
-"resources": {
-"operations": {
+"tensorboards": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel",
+"batchRead": {
+"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.batchRead",
+"parameterOrder": [
+"tensorboard"
+],
+"parameters": {
+"tensorboard": {
+"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeSeries": {
+"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"location": "query",
+"repeated": true,
+"type": "string"
+}
+},
+"path": "v1/{+tensorboard}:batchRead",
+"response": {
+"$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a Tensorboard.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"parent": {
+"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+parent}/tensorboards",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Tensorboard"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
+"description": "Deletes a Tensorboard.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
+"description": "Gets a Tensorboard.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1Tensorboard"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations",
+"description": "Lists Tensorboards in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Lists the Tensorboards that match the filter expression.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "Field to use to sort the list.",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"parent": {
+"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+parent}/tensorboards",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.operations.wait",
+"patch": {
+"description": "Updates a Tensorboard.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.tensorboards.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1Tensorboard"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"ragFiles": {
-"methods": {
-"delete": {
-"description": "Deletes a RagFile.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete",
+"readSize": {
+"description": "Returns the storage size for a given TensorBoard instance.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.readSize",
 "parameterOrder": [
-"name"
+"tensorboard"
 ],
 "parameters": {
-"forceDelete": {
-"description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.",
-"location": "query",
-"type": "boolean"
-},
-"name": {
-"description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
+"tensorboard": {
+"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+tensorboard}:readSize",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a RagFile.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
+"readUsage": {
+"description": "Returns a list of monthly active users for a given TensorBoard instance.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.get",
+"id": "aiplatform.projects.locations.tensorboards.readUsage",
 "parameterOrder": [
-"name"
+"tensorboard"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
+"tensorboard": {
+"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+tensorboard}:readUsage",
 "response": {
-"$ref": "GoogleCloudAiplatformV1RagFile"
+"$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"import": {
-"description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import",
+"resources": {
+"experiments": {
+"methods": {
+"batchCreate": {
+"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.import",
+"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/ragFiles:import",
+"path": "v1/{+parent}:batchCreate",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ImportRagFilesRequest"
+"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists RagFiles in a RagCorpus.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.list",
+"create": {
+"description": "Creates a TensorboardExperiment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"pageSize": {
-"description": "Optional. The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1/{+parent}/ragFiles",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ListRagFilesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
-"required": true,
+"tensorboardExperimentId": {
+"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}:cancel",
+"path": "v1/{+parent}/experiments",
+"request": {
+"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
+"description": "Deletes a TensorboardExperiment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
+"description": "Gets a TensorboardExperiment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations",
+"description": "Lists TensorboardExperiments in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Lists the TensorboardExperiments that match the filter expression.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "Field to use to sort the list.",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"parent": {
+"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+parent}/experiments",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait",
+"patch": {
+"description": "Updates a TensorboardExperiment.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.tensorboards.experiments.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}:wait",
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"write": {
+"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.write",
+"parameterOrder": [
+"tensorboardExperiment"
+],
+"parameters": {
+"tensorboardExperiment": {
+"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"required": true,
+"type": "string"
 }
-}
-}
-}
-}
+},
+"path": "v1/{+tensorboardExperiment}:write",
+"request": {
+"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
-"ragEngineConfig": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -16539,7 +24198,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16554,9 +24213,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -16564,7 +24223,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16579,9 +24238,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -16589,7 +24248,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16604,9 +24263,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -16619,7 +24278,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -16650,9 +24309,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.wait",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -16660,7 +24319,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -16680,57 +24339,83 @@
 ]
 }
 }
-}
-}
 },
-"reasoningEngines": {
+"runs": {
 "methods": {
+"batchCreate": {
+"description": "Batch create TensorboardRuns.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/runs:batchCreate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "create": {
-"description": "Creates a reasoning engine.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
+"description": "Creates a TensorboardRun.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.create",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
+},
+"tensorboardRunId": {
+"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/reasoningEngines",
+"path": "v1/{+parent}/runs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
+"$ref": "GoogleCloudAiplatformV1TensorboardRun"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1TensorboardRun"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a reasoning engine.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"description": "Deletes a TensorboardRun.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16744,156 +24429,141 @@
 ]
 },
 "get": {
-"description": "Gets a reasoning engine.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"description": "Gets a TensorboardRun.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
+"$ref": "GoogleCloudAiplatformV1TensorboardRun"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "list": {
-"description": "Lists reasoning engines in a location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
+"description": "Lists TensorboardRuns in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "Lists the TensorboardRuns that match the filter expression.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Field to use to sort the list.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/reasoningEngines",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates a reasoning engine.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.reasoningEngines.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"parent": {
+"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. Mask specifying which fields to update.",
+"readMask": {
+"description": "Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
-},
+"path": "v1/{+parent}/runs",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"query": {
-"description": "Queries using a reasoning engine.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.query",
+"patch": {
+"description": "Updates a TensorboardRun.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+name}:query",
+"path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest"
+"$ref": "GoogleCloudAiplatformV1TensorboardRun"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse"
+"$ref": "GoogleCloudAiplatformV1TensorboardRun"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamQuery": {
-"description": "Streams queries using a reasoning engine.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery",
+"write": {
+"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.streamQuery",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write",
 "parameterOrder": [
-"name"
+"tensorboardRun"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"tensorboardRun": {
+"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:streamQuery",
+"path": "v1/{+tensorboardRun}:write",
 "request": {
-"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest"
+"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest"
 },
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -16905,9 +24575,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -16915,7 +24585,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16930,9 +24600,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -16940,7 +24610,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16955,9 +24625,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -16965,7 +24635,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16980,9 +24650,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -16995,7 +24665,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -17026,9 +24696,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.wait",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -17036,7 +24706,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -17056,52 +24726,55 @@
 ]
 }
 }
-}
-}
 },
-"schedules": {
+"timeSeries": {
 "methods": {
 "create": {
-"description": "Creates a Schedule.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules",
+"description": "Creates a TensorboardTimeSeries.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.create",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"tensorboardTimeSeriesId": {
+"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/schedules",
+"path": "v1/{+parent}/timeSeries",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Schedule"
+"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Schedule"
+"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a Schedule.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"description": "Deletes a TensorboardTimeSeries.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.schedules.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17114,95 +24787,131 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"exportTensorboardTimeSeries": {
+"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries",
+"parameterOrder": [
+"tensorboardTimeSeries"
+],
+"parameters": {
+"tensorboardTimeSeries": {
+"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries",
+"request": {
+"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
-"description": "Gets a Schedule.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"description": "Gets a TensorboardTimeSeries.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Schedule"
+"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "list": {
-"description": "Lists Schedules in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules",
+"description": "Lists TensorboardTimeSeries in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`",
+"description": "Lists the TensorboardTimeSeries that match the filter expression.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`",
+"description": "Field to use to sort the list.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size. Default to 100 if not specified.",
+"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.",
+"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/schedules",
+"path": "v1/{+parent}/timeSeries",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListSchedulesResponse"
+"$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "patch": {
-"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"description": "Updates a TensorboardTimeSeries.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.schedules.patch",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. The resource name of the Schedule.",
+"description": "Output only. Name of the TensorboardTimeSeries.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
+"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -17210,36 +24919,131 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Schedule"
+"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Schedule"
+"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"pause": {
-"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause",
+"read": {
+"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read",
+"parameterOrder": [
+"tensorboardTimeSeries"
+],
+"parameters": {
+"filter": {
+"description": "Reads the TensorboardTimeSeries' data that match the filter expression.",
+"location": "query",
+"type": "string"
+},
+"maxDataPoints": {
+"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"tensorboardTimeSeries": {
+"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+tensorboardTimeSeries}:read",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"readBlobData": {
+"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData",
+"parameterOrder": [
+"timeSeries"
+],
+"parameters": {
+"blobIds": {
+"description": "IDs of the blobs to read.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"timeSeries": {
+"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+timeSeries}:readBlobData",
+"response": {
+"$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.pause",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:pause",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PauseScheduleRequest"
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1/{+name}",
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -17247,43 +25051,123 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"resume": {
-"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.resume",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:resume",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ResumeScheduleRequest"
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
+}
+}
+}
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -17291,7 +25175,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17306,9 +25190,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.schedules.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -17316,7 +25200,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17331,9 +25215,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -17341,7 +25225,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17356,9 +25240,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -17371,7 +25255,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -17402,9 +25286,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.operations.wait",
+"id": "aiplatform.projects.locations.tensorboards.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -17412,7 +25296,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -17435,54 +25319,77 @@
 }
 }
 },
-"specialistPools": {
+"trainingPipelines": {
 "methods": {
+"cancel": {
+"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.trainingPipelines.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "create": {
-"description": "Creates a SpecialistPool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools",
+"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.specialistPools.create",
+"id": "aiplatform.projects.locations.trainingPipelines.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.",
+"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/specialistPools",
+"path": "v1/{+parent}/trainingPipelines",
 "request": {
-"$ref": "GoogleCloudAiplatformV1SpecialistPool"
+"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a SpecialistPool as well as all Specialists in the pool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
+"description": "Deletes a TrainingPipeline.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.specialistPools.delete",
+"id": "aiplatform.projects.locations.trainingPipelines.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`",
+"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17496,39 +25403,44 @@
 ]
 },
 "get": {
-"description": "Gets a SpecialistPool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
+"description": "Gets a TrainingPipeline.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.get",
+"id": "aiplatform.projects.locations.trainingPipelines.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.",
+"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1SpecialistPool"
+"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists SpecialistPools in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools",
+"description": "Lists TrainingPipelines in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.list",
+"id": "aiplatform.projects.locations.trainingPipelines.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -17536,61 +25448,27 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.",
+"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
 "readMask": {
-"description": "Mask specifying which fields to read. FieldMask represents a set of",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1/{+parent}/specialistPools",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ListSpecialistPoolsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates a SpecialistPool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.specialistPools.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The resource name of the SpecialistPool.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource.",
+"description": "Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1SpecialistPool"
-},
+"path": "v1/{+parent}/trainingPipelines",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -17602,9 +25480,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.specialistPools.operations.cancel",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -17612,7 +25490,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17627,9 +25505,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.specialistPools.operations.delete",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -17637,7 +25515,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17652,9 +25530,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.operations.get",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -17662,7 +25540,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17677,9 +25555,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.operations.list",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -17692,7 +25570,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -17723,9 +25601,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.specialistPools.operations.wait",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -17733,7 +25611,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -17756,145 +25634,153 @@
 }
 }
 },
-"studies": {
+"tuningJobs": {
 "methods": {
-"create": {
-"description": "Creates a Study. A resource name will be generated after creation of the Study.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies",
+"cancel": {
+"description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.create",
+"id": "aiplatform.projects.locations.tuningJobs.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/studies",
+"path": "v1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Study"
+"$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Study"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a Study.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.delete",
+"create": {
+"description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tuningJobs.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"parent": {
+"description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/tuningJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1TuningJob"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1TuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Study by name.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
+"description": "Gets a TuningJob.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.get",
+"id": "aiplatform.projects.locations.tuningJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Study"
+"$ref": "GoogleCloudAiplatformV1TuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists all the studies in a region for an associated project.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies",
+"description": "Lists TuningJobs in a Location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.list",
+"id": "aiplatform.projects.locations.tuningJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
+"description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/studies",
+"path": "v1/{+parent}/tuningJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListStudiesResponse"
+"$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"lookup": {
-"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies:lookup",
+"rebaseTunedModel": {
+"description": "Rebase a TunedModel.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.lookup",
+"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/studies:lookup",
+"path": "v1/{+parent}/tuningJobs:rebaseTunedModel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1LookupStudyRequest"
+"$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Study"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -17906,9 +25792,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.operations.cancel",
+"id": "aiplatform.projects.locations.tuningJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -17916,7 +25802,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17931,9 +25817,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.operations.delete",
+"id": "aiplatform.projects.locations.tuningJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -17941,7 +25827,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17956,9 +25842,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.operations.get",
+"id": "aiplatform.projects.locations.tuningJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -17966,7 +25852,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17981,9 +25867,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.operations.list",
+"id": "aiplatform.projects.locations.tuningJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -17996,7 +25882,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18024,333 +25910,290 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.operations.wait",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1/{+name}:wait",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+}
+}
+}
+}
+}
 }
 }
 },
-"trials": {
+"publishers": {
+"resources": {
+"models": {
 "methods": {
-"addTrialMeasurement": {
-"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement",
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement",
+"id": "aiplatform.publishers.models.computeTokens",
 "parameterOrder": [
-"trialName"
+"endpoint"
 ],
 "parameters": {
-"trialName": {
-"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+trialName}:addTrialMeasurement",
+"path": "v1/{+endpoint}:computeTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1AddTrialMeasurementRequest"
+"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Trial"
+"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"checkTrialEarlyStoppingState": {
-"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState",
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState",
+"id": "aiplatform.publishers.models.countTokens",
 "parameterOrder": [
-"trialName"
+"endpoint"
 ],
 "parameters": {
-"trialName": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+trialName}:checkTrialEarlyStoppingState",
+"path": "v1/{+endpoint}:countTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest"
+"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"complete": {
-"description": "Marks a Trial as complete.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete",
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.complete",
+"id": "aiplatform.publishers.models.fetchPredictOperation",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:complete",
+"path": "v1/{+endpoint}:fetchPredictOperation",
 "request": {
-"$ref": "GoogleCloudAiplatformV1CompleteTrialRequest"
+"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Trial"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"create": {
-"description": "Adds a user provided Trial to a Study.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.create",
+"id": "aiplatform.publishers.models.generateContent",
 "parameterOrder": [
-"parent"
+"model"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/trials",
+"path": "v1/{+model}:generateContent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1Trial"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1Trial"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a Trial.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.trials.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
-"required": true,
-"type": "string"
-}
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
 },
-"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "get": {
-"description": "Gets a Trial.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
+"description": "Gets a Model Garden publisher model.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.get",
+"id": "aiplatform.publishers.models.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
-"required": true,
+"huggingFaceToken": {
+"description": "Optional. Token used to access Hugging Face gated models.",
+"location": "query",
 "type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1Trial"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 },
-"list": {
-"description": "Lists the Trials associated with a Study.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"pageSize": {
-"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.",
-"format": "int32",
+"isHuggingFaceModel": {
+"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.",
 "location": "query",
-"type": "integer"
+"type": "boolean"
 },
-"pageToken": {
-"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
+"languageCode": {
+"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"name": {
+"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
+},
+"view": {
+"description": "Optional. PublisherModel view specifying which fields to read.",
+"enum": [
+"PUBLISHER_MODEL_VIEW_UNSPECIFIED",
+"PUBLISHER_MODEL_VIEW_BASIC",
+"PUBLISHER_MODEL_VIEW_FULL",
+"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
+],
+"enumDescriptions": [
+"The default / unset value. The API will default to the BASIC view.",
+"Include basic metadata about the publisher model, but not the full contents.",
+"Include everything.",
+"Include: VersionId, ModelVersionExternalName, and SupportedActions."
+],
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+parent}/trials",
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListTrialsResponse"
+"$ref": "GoogleCloudAiplatformV1PublisherModel"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listOptimalTrials": {
-"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials",
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials",
+"id": "aiplatform.publishers.models.predict",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the Study that the optimal Trial belongs to.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/trials:listOptimalTrials",
+"path": "v1/{+endpoint}:predict",
 "request": {
-"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsRequest"
+"$ref": "GoogleCloudAiplatformV1PredictRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListOptimalTrialsResponse"
+"$ref": "GoogleCloudAiplatformV1PredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"stop": {
-"description": "Stops a Trial.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop",
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.stop",
+"id": "aiplatform.publishers.models.predictLongRunning",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}:stop",
+"path": "v1/{+endpoint}:predictLongRunning",
 "request": {
-"$ref": "GoogleCloudAiplatformV1StopTrialRequest"
+"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1Trial"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"suggest": {
-"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest",
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.suggest",
+"id": "aiplatform.publishers.models.streamGenerateContent",
 "parameterOrder": [
-"parent"
+"model"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/trials:suggest",
+"path": "v1/{+model}:streamGenerateContent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1SuggestTrialsRequest"
+"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 }
+}
+}
+}
 },
+"ragCorpora": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.operations.cancel",
+"id": "aiplatform.ragCorpora.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -18358,7 +26201,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18373,9 +26216,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.trials.operations.delete",
+"id": "aiplatform.ragCorpora.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -18383,7 +26226,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18398,9 +26241,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.operations.get",
+"id": "aiplatform.ragCorpora.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -18408,7 +26251,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18423,9 +26266,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.operations.list",
+"id": "aiplatform.ragCorpora.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -18438,7 +26281,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18469,9 +26312,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.operations.wait",
+"id": "aiplatform.ragCorpora.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -18479,7 +26322,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18499,500 +26342,178 @@
 ]
 }
 }
-}
-}
-}
-}
 },
-"tensorboards": {
+"ragFiles": {
+"resources": {
+"operations": {
 "methods": {
-"batchRead": {
-"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.batchRead",
-"parameterOrder": [
-"tensorboard"
-],
-"parameters": {
-"tensorboard": {
-"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
-"required": true,
-"type": "string"
-},
-"timeSeries": {
-"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
-"location": "query",
-"repeated": true,
-"type": "string"
-}
-},
-"path": "v1/{+tensorboard}:batchRead",
-"response": {
-"$ref": "GoogleCloudAiplatformV1BatchReadTensorboardTimeSeriesDataResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a Tensorboard.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.create",
+"id": "aiplatform.ragCorpora.ragFiles.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/tensorboards",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Tensorboard"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a Tensorboard.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"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/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.delete",
+"id": "aiplatform.ragCorpora.ragFiles.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Tensorboard.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"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/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.get",
+"id": "aiplatform.ragCorpora.ragFiles.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1Tensorboard"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Tensorboards in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.list",
+"id": "aiplatform.ragCorpora.ragFiles.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Tensorboards that match the filter expression.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Field to use to sort the list.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/tensorboards",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListTensorboardsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a Tensorboard.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.ragCorpora.ragFiles.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1Tensorboard"
-},
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"readSize": {
-"description": "Returns the storage size for a given TensorBoard instance.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.readSize",
-"parameterOrder": [
-"tensorboard"
-],
-"parameters": {
-"tensorboard": {
-"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+tensorboard}:readSize",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ReadTensorboardSizeResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"readUsage": {
-"description": "Returns a list of monthly active users for a given TensorBoard instance.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.readUsage",
-"parameterOrder": [
-"tensorboard"
-],
-"parameters": {
-"tensorboard": {
-"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+tensorboard}:readUsage",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ReadTensorboardUsageResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
-"resources": {
-"experiments": {
-"methods": {
-"batchCreate": {
-"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}:batchCreate",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a TensorboardExperiment.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
-"required": true,
-"type": "string"
-},
-"tensorboardExperimentId": {
-"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1/{+parent}/experiments",
-"request": {
-"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a TensorboardExperiment.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets a TensorboardExperiment.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"list": {
-"description": "Lists TensorboardExperiments in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"filter": {
-"description": "Lists the TensorboardExperiments that match the filter expression.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field to use to sort the list.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1/{+parent}/experiments",
-"response": {
-"$ref": "GoogleCloudAiplatformV1ListTensorboardExperimentsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"patch": {
-"description": "Updates a TensorboardExperiment.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.experiments.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardExperiment"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"write": {
-"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.write",
-"parameterOrder": [
-"tensorboardExperiment"
-],
-"parameters": {
-"tensorboardExperiment": {
-"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1/{+tensorboardExperiment}:write",
-"request": {
-"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1WriteTensorboardExperimentDataResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 }
 },
+"ragEngineConfig": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/ragEngineConfig/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel",
+"id": "aiplatform.ragEngineConfig.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -19000,7 +26521,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19015,9 +26536,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
+"flatPath": "v1/ragEngineConfig/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete",
+"id": "aiplatform.ragEngineConfig.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -19025,7 +26546,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19040,9 +26561,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
+"flatPath": "v1/ragEngineConfig/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get",
+"id": "aiplatform.ragEngineConfig.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -19050,7 +26571,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19065,9 +26586,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations",
+"flatPath": "v1/ragEngineConfig/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list",
+"id": "aiplatform.ragEngineConfig.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -19080,7 +26601,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^ragEngineConfig$",
 "required": true,
 "type": "string"
 },
@@ -19111,9 +26632,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait",
+"flatPath": "v1/ragEngineConfig/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait",
+"id": "aiplatform.ragEngineConfig.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -19121,103 +26642,73 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1/{+name}:wait",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-},
-"runs": {
-"methods": {
-"batchCreate": {
-"description": "Batch create TensorboardRuns.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/runs:batchCreate",
-"request": {
-"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest"
-},
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1BatchCreateTensorboardRunsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
+"reasoningEngines": {
+"methods": {
 "create": {
-"description": "Creates a TensorboardRun.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
+"description": "Creates a reasoning engine.",
+"flatPath": "v1/reasoningEngines",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create",
-"parameterOrder": [
-"parent"
-],
+"id": "aiplatform.reasoningEngines.create",
+"parameterOrder": [],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
-},
-"tensorboardRunId": {
-"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
+"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/runs",
+"path": "v1/reasoningEngines",
 "request": {
-"$ref": "GoogleCloudAiplatformV1TensorboardRun"
+"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardRun"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a TensorboardRun.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"description": "Deletes a reasoning engine.",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete",
+"id": "aiplatform.reasoningEngines.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19231,102 +26722,85 @@
 ]
 },
 "get": {
-"description": "Gets a TensorboardRun.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"description": "Gets a reasoning engine.",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get",
+"id": "aiplatform.reasoningEngines.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardRun"
+"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TensorboardRuns in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
+"description": "Lists reasoning engines in a location.",
+"flatPath": "v1/reasoningEngines",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list",
-"parameterOrder": [
-"parent"
-],
+"id": "aiplatform.reasoningEngines.list",
+"parameterOrder": [],
 "parameters": {
 "filter": {
-"description": "Lists the TensorboardRuns that match the filter expression.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field to use to sort the list.",
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/runs",
+"path": "v1/reasoningEngines",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListTensorboardRunsResponse"
+"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a TensorboardRun.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"description": "Updates a reasoning engine.",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch",
+"id": "aiplatform.reasoningEngines.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"description": "Optional. Mask specifying which fields to update.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -19334,38 +26808,66 @@
 },
 "path": "v1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1TensorboardRun"
+"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardRun"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"write": {
-"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write",
+"query": {
+"description": "Queries using a reasoning engine.",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write",
+"id": "aiplatform.reasoningEngines.query",
 "parameterOrder": [
-"tensorboardRun"
+"name"
 ],
 "parameters": {
-"tensorboardRun": {
-"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+tensorboardRun}:write",
+"path": "v1/{+name}:query",
 "request": {
-"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataRequest"
+"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1WriteTensorboardRunDataResponse"
+"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"streamQuery": {
+"description": "Streams queries using a reasoning engine.",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.streamQuery",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:streamQuery",
+"request": {
+"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -19377,9 +26879,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel",
+"id": "aiplatform.reasoningEngines.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -19387,7 +26889,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19402,9 +26904,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete",
+"id": "aiplatform.reasoningEngines.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -19412,7 +26914,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19427,9 +26929,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get",
+"id": "aiplatform.reasoningEngines.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -19437,7 +26939,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19452,9 +26954,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list",
+"id": "aiplatform.reasoningEngines.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -19467,7 +26969,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19498,9 +27000,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait",
+"flatPath": "v1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait",
+"id": "aiplatform.reasoningEngines.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -19508,7 +27010,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19528,286 +27030,338 @@
 ]
 }
 }
+}
+}
 },
-"timeSeries": {
+"schedules": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a TensorboardTimeSeries.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create",
+"id": "aiplatform.schedules.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"tensorboardTimeSeriesId": {
-"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1/{+parent}/timeSeries",
-"request": {
-"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a TensorboardTimeSeries.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
+"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/schedules/{schedulesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete",
+"id": "aiplatform.schedules.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"exportTensorboardTimeSeries": {
-"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries",
-"parameterOrder": [
-"tensorboardTimeSeries"
-],
-"parameters": {
-"tensorboardTimeSeries": {
-"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TensorboardTimeSeries.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
+"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/schedules/{schedulesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get",
+"id": "aiplatform.schedules.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TensorboardTimeSeries in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/schedules/{schedulesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list",
+"id": "aiplatform.schedules.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the TensorboardTimeSeries that match the filter expression.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Field to use to sort the list.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^schedules/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/schedules/{schedulesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.schedules.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/timeSeries",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListTensorboardTimeSeriesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"patch": {
-"description": "Updates a TensorboardTimeSeries.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch",
+"specialistPools": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.specialistPools.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the TensorboardTimeSeries.",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.specialistPools.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.specialistPools.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TensorboardTimeSeries"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"read": {
-"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/specialistPools/{specialistPoolsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read",
+"id": "aiplatform.specialistPools.operations.list",
 "parameterOrder": [
-"tensorboardTimeSeries"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Reads the TensorboardTimeSeries' data that match the filter expression.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"maxDataPoints": {
-"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^specialistPools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
-"tensorboardTimeSeries": {
-"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
-"required": true,
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+tensorboardTimeSeries}:read",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReadTensorboardTimeSeriesDataResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"readBlobData": {
-"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.specialistPools.operations.wait",
 "parameterOrder": [
-"timeSeries"
+"name"
 ],
 "parameters": {
-"blobIds": {
-"description": "IDs of the blobs to read.",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"timeSeries": {
-"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1/{+timeSeries}:readBlobData",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReadTensorboardBlobDataResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"studies": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/studies/{studiesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel",
+"id": "aiplatform.studies.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -19815,7 +27369,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19830,9 +27384,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"flatPath": "v1/studies/{studiesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete",
+"id": "aiplatform.studies.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -19840,7 +27394,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19855,9 +27409,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"flatPath": "v1/studies/{studiesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get",
+"id": "aiplatform.studies.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -19865,7 +27419,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19880,9 +27434,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations",
+"flatPath": "v1/studies/{studiesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list",
+"id": "aiplatform.studies.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -19895,7 +27449,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^studies/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19926,9 +27480,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait",
+"flatPath": "v1/studies/{studiesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait",
+"id": "aiplatform.studies.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -19936,7 +27490,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19956,20 +27510,16 @@
 ]
 }
 }
-}
-}
-}
-}
-}
-}
 },
+"trials": {
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.operations.cancel",
+"id": "aiplatform.studies.trials.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -19977,7 +27527,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19992,9 +27542,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
+"flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.operations.delete",
+"id": "aiplatform.studies.trials.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -20002,7 +27552,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20017,9 +27567,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
+"flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.operations.get",
+"id": "aiplatform.studies.trials.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -20027,7 +27577,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20042,9 +27592,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations",
+"flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.operations.list",
+"id": "aiplatform.studies.trials.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -20057,7 +27607,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20088,9 +27638,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait",
+"flatPath": "v1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.operations.wait",
+"id": "aiplatform.studies.trials.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -20098,7 +27648,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20120,30 +27670,33 @@
 }
 }
 }
+}
+}
 },
-"trainingPipelines": {
+"tensorboards": {
+"resources": {
+"experiments": {
+"resources": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.cancel",
+"id": "aiplatform.tensorboards.experiments.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelTrainingPipelineRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -20151,98 +27704,77 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/trainingPipelines",
-"request": {
-"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes a TrainingPipeline.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
+"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/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.trainingPipelines.delete",
+"id": "aiplatform.tensorboards.experiments.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TrainingPipeline.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
+"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/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.get",
+"id": "aiplatform.tensorboards.experiments.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TrainingPipeline"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TrainingPipelines in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.list",
+"id": "aiplatform.tensorboards.experiments.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -20250,41 +27782,66 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.tensorboards.experiments.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/trainingPipelines",
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListTrainingPipelinesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
 },
+"runs": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel",
+"id": "aiplatform.tensorboards.experiments.runs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -20292,7 +27849,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20307,9 +27864,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.delete",
+"id": "aiplatform.tensorboards.experiments.runs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -20317,7 +27874,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20332,9 +27889,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.get",
+"id": "aiplatform.tensorboards.experiments.runs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -20342,7 +27899,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20357,9 +27914,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.list",
+"id": "aiplatform.tensorboards.experiments.runs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -20372,7 +27929,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20403,9 +27960,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.wait",
+"id": "aiplatform.tensorboards.experiments.runs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -20413,7 +27970,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20433,32 +27990,29 @@
 ]
 }
 }
-}
-}
 },
-"tuningJobs": {
+"timeSeries": {
+"resources": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.cancel",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -20466,121 +28020,126 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.create",
+"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/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/tuningJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1TuningJob"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TuningJob"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TuningJob.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}",
+"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/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tuningJobs.get",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1TuningJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TuningJobs in a Location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tuningJobs.list",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+parent}/tuningJobs",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"rebaseTunedModel": {
-"description": "Rebase a TunedModel.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+parent}/tuningJobs:rebaseTunedModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -20588,15 +28147,21 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
+}
+}
+}
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.operations.cancel",
+"id": "aiplatform.tensorboards.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -20604,7 +28169,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20619,9 +28184,9 @@
 },
 "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/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+"flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tuningJobs.operations.delete",
+"id": "aiplatform.tensorboards.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -20629,7 +28194,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20644,9 +28209,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+"flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tuningJobs.operations.get",
+"id": "aiplatform.tensorboards.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -20654,7 +28219,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20669,9 +28234,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations",
+"flatPath": "v1/tensorboards/{tensorboardsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tuningJobs.operations.list",
+"id": "aiplatform.tensorboards.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -20684,7 +28249,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
+"pattern": "^tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20712,493 +28277,333 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
-}
-}
-}
-}
 },
-"publishers": {
-"resources": {
-"models": {
-"methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:computeTokens",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.publishers.models.computeTokens",
+"id": "aiplatform.tensorboards.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1/{+endpoint}:computeTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ComputeTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:countTokens",
+"trainingPipelines": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.publishers.models.countTokens",
+"id": "aiplatform.trainingPipelines.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1CountTokensRequest"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1CountTokensResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.fetchPredictOperation",
+"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/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.trainingPipelines.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:fetchPredictOperation",
-"request": {
-"$ref": "GoogleCloudAiplatformV1FetchPredictOperationRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:generateContent",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.generateContent",
+"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/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.trainingPipelines.operations.get",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+model}:generateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
-},
+"path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a Model Garden publisher model.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.publishers.models.get",
+"id": "aiplatform.trainingPipelines.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"huggingFaceToken": {
-"description": "Optional. Token used to access Hugging Face gated models.",
-"location": "query",
-"type": "string"
-},
-"isHuggingFaceModel": {
-"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.",
-"location": "query",
-"type": "boolean"
-},
-"languageCode": {
-"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.",
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "name": {
-"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 },
-"view": {
-"description": "Optional. PublisherModel view specifying which fields to read.",
-"enum": [
-"PUBLISHER_MODEL_VIEW_UNSPECIFIED",
-"PUBLISHER_MODEL_VIEW_BASIC",
-"PUBLISHER_MODEL_VIEW_FULL",
-"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
-],
-"enumDescriptions": [
-"The default / unset value. The API will default to the BASIC view.",
-"Include basic metadata about the publisher model, but not the full contents.",
-"Include everything.",
-"Include: VersionId, ModelVersionExternalName, and SupportedActions."
-],
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1PublisherModel"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predict",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.publishers.models.predict",
+"id": "aiplatform.trainingPipelines.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1/{+endpoint}:predict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PredictRequest"
 },
-"response": {
-"$ref": "GoogleCloudAiplatformV1PredictResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.predictLongRunning",
-"parameterOrder": [
-"endpoint"
-],
-"parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+endpoint}:predictLongRunning",
-"request": {
-"$ref": "GoogleCloudAiplatformV1PredictLongRunningRequest"
-},
+"path": "v1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.streamGenerateContent",
-"parameterOrder": [
-"model"
-],
-"parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1GenerateContentResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
 }
 }
 },
-"reasoningEngines": {
+"tuningJobs": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a reasoning engine.",
-"flatPath": "v1/reasoningEngines",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.create",
-"parameterOrder": [],
+"id": "aiplatform.tuningJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^tuningJobs/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1/reasoningEngines",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
-},
+"path": "v1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a reasoning engine.",
-"flatPath": "v1/reasoningEngines/{reasoningEnginesId}",
+"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/tuningJobs/{tuningJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.reasoningEngines.delete",
+"id": "aiplatform.tuningJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a reasoning engine.",
-"flatPath": "v1/reasoningEngines/{reasoningEnginesId}",
+"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/tuningJobs/{tuningJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.get",
+"id": "aiplatform.tuningJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists reasoning engines in a location.",
-"flatPath": "v1/reasoningEngines",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/tuningJobs/{tuningJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.list",
-"parameterOrder": [],
+"id": "aiplatform.tuningJobs.operations.list",
+"parameterOrder": [
+"name"
+],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^tuningJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1/reasoningEngines",
+"path": "v1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1ListReasoningEnginesResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"patch": {
-"description": "Updates a reasoning engine.",
-"flatPath": "v1/reasoningEngines/{reasoningEnginesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.reasoningEngines.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Optional. Mask specifying which fields to update.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1ReasoningEngine"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"query": {
-"description": "Queries using a reasoning engine.",
-"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:query",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.query",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}:query",
-"request": {
-"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1QueryReasoningEngineResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"streamQuery": {
-"description": "Streams queries using a reasoning engine.",
-"flatPath": "v1/reasoningEngines/{reasoningEnginesId}:streamQuery",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.streamQuery",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1/{+name}:streamQuery",
-"request": {
-"$ref": "GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest"
-},
-"response": {
-"$ref": "GoogleApiHttpBody"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 }
 }
 }
 },
-"revision": "20251003",
+"revision": "20251028",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -23063,16 +30468,16 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1Blob": {
-"description": "Content blob.",
+"description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.",
 "id": "GoogleCloudAiplatformV1Blob",
 "properties": {
 "data": {
-"description": "Required. Raw bytes.",
+"description": "Required. The raw bytes of the data.",
 "format": "byte",
 "type": "string"
 },
 "displayName": {
-"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.",
 "type": "string"
 },
 "mimeType": {
@@ -23286,28 +30691,28 @@
 "id": "GoogleCloudAiplatformV1Candidate",
 "properties": {
 "avgLogprobs": {
-"description": "Output only. Average log probability score of the candidate.",
+"description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.",
 "format": "double",
 "readOnly": true,
 "type": "number"
 },
 "citationMetadata": {
 "$ref": "GoogleCloudAiplatformV1CitationMetadata",
-"description": "Output only. Source attribution of the generated content.",
+"description": "Output only. A collection of citations that apply to the generated content.",
 "readOnly": true
 },
 "content": {
 "$ref": "GoogleCloudAiplatformV1Content",
-"description": "Output only. Content parts of the candidate.",
+"description": "Output only. The content of the candidate.",
 "readOnly": true
 },
 "finishMessage": {
-"description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.",
+"description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.",
 "readOnly": true,
 "type": "string"
 },
 "finishReason": {
-"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.",
+"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.",
 "enum": [
 "FINISH_REASON_UNSPECIFIED",
 "STOP",
@@ -23329,44 +30734,44 @@
 ],
 "enumDescriptions": [
 "The finish reason is unspecified.",
-"Token generation reached a natural stopping point or a configured stop sequence.",
-"Token generation reached the configured maximum output tokens.",
-"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.",
-"The token generation stopped because of potential recitation.",
-"All other reasons that stopped the token generation.",
-"Token generation stopped because the content contains forbidden terms.",
-"Token generation stopped for potentially containing prohibited content.",
-"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).",
-"The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).",
+"The model reached a natural stopping point or a configured stop sequence.",
+"The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.",
+"The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.",
+"The model stopped generating because the content may be a recitation from a source.",
+"The model stopped generating for a reason not otherwise specified.",
+"The model stopped generating because the content contains a term from a configured blocklist.",
+"The model stopped generating because the content may be prohibited.",
+"The model stopped generating because the content may contain sensitive personally identifiable information (SPII).",
+"The model generated a function call that is syntactically invalid and can't be parsed.",
 "The model response was blocked by Model Armor.",
-"Token generation stopped because generated images has safety violations.",
-"Image generation stopped because generated images has other prohibited content.",
-"Image generation stopped due to recitation.",
-"Image generation stopped because of other miscellaneous issue.",
-"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).",
-"The model was expected to generate an image, but none was generated."
+"The generated image potentially violates safety policies.",
+"The generated image may contain prohibited content.",
+"The generated image may be a recitation from a source.",
+"The image generation stopped for a reason not otherwise specified.",
+"The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.",
+"The model was expected to generate an image, but didn't."
 ],
 "readOnly": true,
 "type": "string"
 },
 "groundingMetadata": {
 "$ref": "GoogleCloudAiplatformV1GroundingMetadata",
-"description": "Output only. Metadata specifies sources used to ground generated content.",
+"description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.",
 "readOnly": true
 },
 "index": {
-"description": "Output only. Index of the candidate.",
+"description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "logprobsResult": {
 "$ref": "GoogleCloudAiplatformV1LogprobsResult",
-"description": "Output only. Log-likelihood scores for the response tokens and top tokens",
+"description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".",
 "readOnly": true
 },
 "safetyRatings": {
-"description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.",
+"description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1SafetyRating"
 },
@@ -23375,7 +30780,7 @@
 },
 "urlContextMetadata": {
 "$ref": "GoogleCloudAiplatformV1UrlContextMetadata",
-"description": "Output only. Metadata related to url context retrieval tool.",
+"description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.",
 "readOnly": true
 }
 },
@@ -23493,38 +30898,38 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1Citation": {
-"description": "Source attributions for content.",
+"description": "A citation for a piece of generatedcontent.",
 "id": "GoogleCloudAiplatformV1Citation",
 "properties": {
 "endIndex": {
-"description": "Output only. End index into the content.",
+"description": "Output only. The end index of the citation in the content.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "license": {
-"description": "Output only. License of the attribution.",
+"description": "Output only. The license of the source of the citation.",
 "readOnly": true,
 "type": "string"
 },
 "publicationDate": {
 "$ref": "GoogleTypeDate",
-"description": "Output only. Publication date of the attribution.",
+"description": "Output only. The publication date of the source of the citation.",
 "readOnly": true
 },
 "startIndex": {
-"description": "Output only. Start index into the content.",
+"description": "Output only. The start index of the citation in the content.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "title": {
-"description": "Output only. Title of the attribution.",
+"description": "Output only. The title of the source of the citation.",
 "readOnly": true,
 "type": "string"
 },
 "uri": {
-"description": "Output only. Url reference of the attribution.",
+"description": "Output only. The URI of the source of the citation.",
 "readOnly": true,
 "type": "string"
 }
@@ -23532,11 +30937,11 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1CitationMetadata": {
-"description": "A collection of source attributions for a piece of content.",
+"description": "A collection of citations that apply to a piece of generated content.",
 "id": "GoogleCloudAiplatformV1CitationMetadata",
 "properties": {
 "citations": {
-"description": "Output only. List of citations.",
+"description": "Output only. A list of citations for the content.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1Citation"
 },
@@ -23900,18 +31305,18 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1Content": {
-"description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.",
+"description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.",
 "id": "GoogleCloudAiplatformV1Content",
 "properties": {
 "parts": {
-"description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.",
+"description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1Part"
 },
 "type": "array"
 },
 "role": {
-"description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.",
+"description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.",
 "type": "string"
 }
 },
@@ -24271,7 +31676,9 @@
 "GETTING_CONTAINER_IMAGE",
 "STARTING_MODEL_SERVER",
 "FINISHING_UP",
-"DEPLOYMENT_TERMINATED"
+"DEPLOYMENT_TERMINATED",
+"SUCCESSFULLY_DEPLOYED",
+"FAILED_TO_DEPLOY"
 ],
 "enumDescriptions": [
 "Default value. This value is unused.",
@@ -24282,7 +31689,9 @@
 "The deployment is getting the container image for the model server.",
 "The deployment is starting the model server.",
 "The deployment is performing finalization steps.",
-"The deployment has terminated."
+"The deployment has terminated.",
+"The deployment has succeeded.",
+"The deployment has failed."
 ],
 "readOnly": true,
 "type": "string"
@@ -24588,6 +31997,17 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1CustomCodeExecutionSpec": {
+"description": "Specificies a metric that is populated by evaluating user-defined Python code.",
+"id": "GoogleCloudAiplatformV1CustomCodeExecutionSpec",
+"properties": {
+"evaluationFunction": {
+"description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text=\"The answer is 4.\"), reference=EvaluationInstance.InstanceData(text=\"4\") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1CustomJob": {
 "description": "Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).",
 "id": "GoogleCloudAiplatformV1CustomJob",
@@ -25086,6 +32506,88 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1DatasetDistribution": {
+"description": "Distribution computed over a tuning dataset.",
+"id": "GoogleCloudAiplatformV1DatasetDistribution",
+"properties": {
+"buckets": {
+"description": "Output only. Defines the histogram bucket.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket"
+},
+"readOnly": true,
+"type": "array"
+},
+"max": {
+"description": "Output only. The maximum of the population values.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"mean": {
+"description": "Output only. The arithmetic mean of the values in the population.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"median": {
+"description": "Output only. The median of the values in the population.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"min": {
+"description": "Output only. The minimum of the population values.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"p5": {
+"description": "Output only. The 5th percentile of the values in the population.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"p95": {
+"description": "Output only. The 95th percentile of the values in the population.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"sum": {
+"description": "Output only. Sum of a given population of values.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1DatasetDistributionDistributionBucket": {
+"description": "Dataset bucket used to create a histogram for the distribution given a population of values.",
+"id": "GoogleCloudAiplatformV1DatasetDistributionDistributionBucket",
+"properties": {
+"count": {
+"description": "Output only. Number of values in the bucket.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"left": {
+"description": "Output only. Left bound of the bucket.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"right": {
+"description": "Output only. Right bound of the bucket.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1DatasetVersion": {
 "description": "Describes the dataset version.",
 "id": "GoogleCloudAiplatformV1DatasetVersion",
@@ -25364,7 +32866,9 @@
 "GETTING_CONTAINER_IMAGE",
 "STARTING_MODEL_SERVER",
 "FINISHING_UP",
-"DEPLOYMENT_TERMINATED"
+"DEPLOYMENT_TERMINATED",
+"SUCCESSFULLY_DEPLOYED",
+"FAILED_TO_DEPLOY"
 ],
 "enumDescriptions": [
 "Default value. This value is unused.",
@@ -25375,7 +32879,9 @@
 "The deployment is getting the container image for the model server.",
 "The deployment is starting the model server.",
 "The deployment is performing finalization steps.",
-"The deployment has terminated."
+"The deployment has terminated.",
+"The deployment has succeeded.",
+"The deployment has failed."
 ],
 "readOnly": true,
 "type": "string"
@@ -26063,6 +33569,90 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1EmbedContentRequest": {
+"description": "Request message for PredictionService.EmbedContent.",
+"id": "GoogleCloudAiplatformV1EmbedContentRequest",
+"properties": {
+"autoTruncate": {
+"description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.",
+"type": "boolean"
+},
+"content": {
+"$ref": "GoogleCloudAiplatformV1Content",
+"description": "Required. Input content to be embedded. Required."
+},
+"outputDimensionality": {
+"description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.",
+"format": "int32",
+"type": "integer"
+},
+"taskType": {
+"description": "Optional. The task type of the embedding.",
+"enum": [
+"UNSPECIFIED",
+"RETRIEVAL_QUERY",
+"RETRIEVAL_DOCUMENT",
+"SEMANTIC_SIMILARITY",
+"CLASSIFICATION",
+"CLUSTERING",
+"QUESTION_ANSWERING",
+"FACT_VERIFICATION",
+"CODE_RETRIEVAL_QUERY"
+],
+"enumDescriptions": [
+"Unset value, which will default to one of the other enum values.",
+"Specifies the given text is a query in a search/retrieval setting.",
+"Specifies the given text is a document from the corpus being searched.",
+"Specifies the given text will be used for STS.",
+"Specifies that the given text will be classified.",
+"Specifies that the embeddings will be used for clustering.",
+"Specifies that the embeddings will be used for question answering.",
+"Specifies that the embeddings will be used for fact verification.",
+"Specifies that the embeddings will be used for code retrieval."
+],
+"type": "string"
+},
+"title": {
+"description": "Optional. An optional title for the text.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1EmbedContentResponse": {
+"description": "Response message for PredictionService.EmbedContent.",
+"id": "GoogleCloudAiplatformV1EmbedContentResponse",
+"properties": {
+"embedding": {
+"$ref": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding",
+"description": "The embedding generated from the input content."
+},
+"truncated": {
+"description": "Whether the input content was truncated before generating the embedding.",
+"type": "boolean"
+},
+"usageMetadata": {
+"$ref": "GoogleCloudAiplatformV1UsageMetadata",
+"description": "Metadata about the response(s)."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1EmbedContentResponseEmbedding": {
+"description": "A list of floats representing an embedding.",
+"id": "GoogleCloudAiplatformV1EmbedContentResponseEmbedding",
+"properties": {
+"values": {
+"description": "Embedding vector values.",
+"items": {
+"format": "float",
+"type": "number"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1EncryptionSpec": {
 "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.",
 "id": "GoogleCloudAiplatformV1EncryptionSpec",
@@ -26785,6 +34375,10 @@
 "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations",
 "id": "GoogleCloudAiplatformV1EvaluationInstance",
 "properties": {
+"agentData": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentData",
+"description": "Optional. Data used for agent evaluation."
+},
 "otherData": {
 "$ref": "GoogleCloudAiplatformV1EvaluationInstanceMapInstance",
 "description": "Optional. Other data used to populate placeholders based on their key."
@@ -26811,6 +34405,102 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1EvaluationInstanceAgentConfig": {
+"description": "Configuration for an Agent.",
+"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig",
+"properties": {
+"developerInstruction": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData",
+"description": "Optional. A field containing instructions from the developer for the agent."
+},
+"tools": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools",
+"description": "List of tools."
+},
+"toolsText": {
+"description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools": {
+"description": "Represents a list of tools for an agent.",
+"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfigTools",
+"properties": {
+"tool": {
+"description": "Optional. List of tools: each tool can have multiple function declarations.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Tool"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1EvaluationInstanceAgentData": {
+"description": "Contains data specific to agent evaluations.",
+"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentData",
+"properties": {
+"agentConfig": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig",
+"description": "Optional. Agent configuration."
+},
+"developerInstruction": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData",
+"deprecated": true,
+"description": "Optional. A field containing instructions from the developer for the agent."
+},
+"events": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents",
+"description": "A list of events."
+},
+"eventsText": {
+"description": "A JSON string containing a sequence of events.",
+"type": "string"
+},
+"tools": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools",
+"deprecated": true,
+"description": "List of tools."
+},
+"toolsText": {
+"deprecated": true,
+"description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { \"name\": \"search_actors\", \"description\": \"Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.\", \"parameters\": [ { \"name\": \"movie_name\", \"description\": \"The name of the movie.\" }, { \"name\": \"character_name\", \"description\": \"The name of the character.\" } ], \"required\": [\"movie_name\", \"character_name\"] } ]",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents": {
+"description": "Represents a list of events for an agent.",
+"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataEvents",
+"properties": {
+"event": {
+"description": "Optional. A list of events.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Content"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools": {
+"description": "Represents a list of tools for an agent.",
+"id": "GoogleCloudAiplatformV1EvaluationInstanceAgentDataTools",
+"properties": {
+"tool": {
+"deprecated": true,
+"description": "Optional. List of tools: each tool can have multiple function declarations.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Tool"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1EvaluationInstanceInstanceData": {
 "description": "Instance data used to populate placeholders in a metric prompt template.",
 "id": "GoogleCloudAiplatformV1EvaluationInstanceInstanceData",
@@ -27266,6 +34956,10 @@
 "description": "Required. The name of the metric.",
 "type": "string"
 },
+"metricConfig": {
+"$ref": "GoogleCloudAiplatformV1Metric",
+"description": "The metric config."
+},
 "predefinedMetricSpec": {
 "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricPredefinedMetricSpec",
 "description": "Spec for a pre-defined metric."
@@ -29929,15 +37623,15 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1FileData": {
-"description": "URI based data.",
+"description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.",
 "id": "GoogleCloudAiplatformV1FileData",
 "properties": {
 "displayName": {
-"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.",
 "type": "string"
 },
 "fileUri": {
-"description": "Required. URI.",
+"description": "Required. The URI of the file in Google Cloud Storage.",
 "type": "string"
 },
 "mimeType": {
@@ -30353,6 +38047,13 @@
 "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
 "type": "string"
 },
+"parts": {
+"description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1FunctionResponsePart"
+},
+"type": "array"
+},
 "response": {
 "additionalProperties": {
 "description": "Properties of the object.",
@@ -30364,6 +38065,60 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1FunctionResponseBlob": {
+"description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.",
+"id": "GoogleCloudAiplatformV1FunctionResponseBlob",
+"properties": {
+"data": {
+"description": "Required. Raw bytes.",
+"format": "byte",
+"type": "string"
+},
+"displayName": {
+"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"type": "string"
+},
+"mimeType": {
+"description": "Required. The IANA standard MIME type of the source data.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1FunctionResponseFileData": {
+"description": "URI based data for function response.",
+"id": "GoogleCloudAiplatformV1FunctionResponseFileData",
+"properties": {
+"displayName": {
+"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"type": "string"
+},
+"fileUri": {
+"description": "Required. URI.",
+"type": "string"
+},
+"mimeType": {
+"description": "Required. The IANA standard MIME type of the source data.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1FunctionResponsePart": {
+"description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.",
+"id": "GoogleCloudAiplatformV1FunctionResponsePart",
+"properties": {
+"fileData": {
+"$ref": "GoogleCloudAiplatformV1FunctionResponseFileData",
+"description": "URI based data."
+},
+"inlineData": {
+"$ref": "GoogleCloudAiplatformV1FunctionResponseBlob",
+"description": "Inline media bytes."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1GcsDestination": {
 "description": "The Google Cloud Storage location where the output is to be written to.",
 "id": "GoogleCloudAiplatformV1GcsDestination",
@@ -30400,6 +38155,43 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1GeminiPreferenceExample": {
+"description": "Input example for preference optimization.",
+"id": "GoogleCloudAiplatformV1GeminiPreferenceExample",
+"properties": {
+"completions": {
+"description": "List of completions for a given prompt.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion"
+},
+"type": "array"
+},
+"contents": {
+"description": "Multi-turn contents that represents the Prompt.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1Content"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion": {
+"description": "Completion and its preference score.",
+"id": "GoogleCloudAiplatformV1GeminiPreferenceExampleCompletion",
+"properties": {
+"completion": {
+"$ref": "GoogleCloudAiplatformV1Content",
+"description": "Single turn completion for the given prompt."
+},
+"score": {
+"description": "The score for the given completion.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig": {
 "description": "Configuration for GenAiAdvancedFeatures.",
 "id": "GoogleCloudAiplatformV1GenAiAdvancedFeaturesConfig",
@@ -30675,6 +38467,10 @@
 "description": "Request message for EvaluationService.GenerateInstanceRubrics.",
 "id": "GoogleCloudAiplatformV1GenerateInstanceRubricsRequest",
 "properties": {
+"agentConfig": {
+"$ref": "GoogleCloudAiplatformV1EvaluationInstanceAgentConfig",
+"description": "Optional. Agent configuration, required for agent-based rubric generation."
+},
 "contents": {
 "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.",
 "items": {
@@ -30806,24 +38602,24 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerationConfig": {
-"description": "Generation config.",
+"description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.",
 "id": "GoogleCloudAiplatformV1GenerationConfig",
 "properties": {
 "audioTimestamp": {
-"description": "Optional. If enabled, audio timestamp will be included in the request to the model.",
+"description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.",
 "type": "boolean"
 },
 "candidateCount": {
-"description": "Optional. Number of candidates to generate.",
+"description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.",
 "format": "int32",
 "type": "integer"
 },
 "enableAffectiveDialog": {
-"description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.",
+"description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.",
 "type": "boolean"
 },
 "frequencyPenalty": {
-"description": "Optional. Frequency penalties.",
+"description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].",
 "format": "float",
 "type": "number"
 },
@@ -30832,17 +38628,17 @@
 "description": "Optional. Config for image generation features."
 },
 "logprobs": {
-"description": "Optional. Logit probabilities.",
+"description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.",
 "format": "int32",
 "type": "integer"
 },
 "maxOutputTokens": {
-"description": "Optional. The maximum number of output tokens to generate per message.",
+"description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.",
 "format": "int32",
 "type": "integer"
 },
 "mediaResolution": {
-"description": "Optional. If specified, the media resolution specified will be used.",
+"description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.",
 "enum": [
 "MEDIA_RESOLUTION_UNSPECIFIED",
 "MEDIA_RESOLUTION_LOW",
@@ -30858,24 +38654,24 @@
 "type": "string"
 },
 "presencePenalty": {
-"description": "Optional. Positive penalties.",
+"description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].",
 "format": "float",
 "type": "number"
 },
 "responseJsonSchema": {
-"description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.",
+"description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.",
 "type": "any"
 },
 "responseLogprobs": {
-"description": "Optional. If true, export the logprobs results in response.",
+"description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.",
 "type": "boolean"
 },
 "responseMimeType": {
-"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
+"description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
 "type": "string"
 },
 "responseModalities": {
-"description": "Optional. The modalities of the response.",
+"description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.",
 "items": {
 "enum": [
 "MODALITY_UNSPECIFIED",
@@ -30895,14 +38691,14 @@
 },
 "responseSchema": {
 "$ref": "GoogleCloudAiplatformV1Schema",
-"description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response."
+"description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`."
 },
 "routingConfig": {
 "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig",
 "description": "Optional. Routing configuration."
 },
 "seed": {
-"description": "Optional. Seed.",
+"description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.",
 "format": "int32",
 "type": "integer"
 },
@@ -30911,28 +38707,28 @@
 "description": "Optional. The speech generation config."
 },
 "stopSequences": {
-"description": "Optional. Stop sequences.",
+"description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "temperature": {
-"description": "Optional. Controls the randomness of predictions.",
+"description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].",
 "format": "float",
 "type": "number"
 },
 "thinkingConfig": {
 "$ref": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig",
-"description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking."
+"description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking."
 },
 "topK": {
-"description": "Optional. If specified, top-k sampling will be used.",
+"description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.",
 "format": "float",
 "type": "number"
 },
 "topP": {
-"description": "Optional. If specified, nucleus sampling will be used.",
+"description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.",
 "format": "float",
 "type": "number"
 }
@@ -30940,22 +38736,22 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerationConfigRoutingConfig": {
-"description": "The configuration for routing the request to a specific model.",
+"description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.",
 "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig",
 "properties": {
 "autoMode": {
 "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode",
-"description": "Automated routing."
+"description": "In this mode, the model is selected automatically based on the content of the request."
 },
 "manualMode": {
 "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode",
-"description": "Manual routing."
+"description": "In this mode, the model is specified manually."
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": {
-"description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
+"description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
 "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode",
 "properties": {
 "modelRoutingPreference": {
@@ -30968,9 +38764,9 @@
 ],
 "enumDescriptions": [
 "Unspecified model routing preference.",
-"Prefer higher quality over low cost.",
-"Balanced model routing preference.",
-"Prefer lower cost over higher quality."
+"The model will be selected to prioritize the quality of the response.",
+"The model will be selected to balance quality and cost.",
+"The model will be selected to prioritize the cost of the request."
 ],
 "type": "string"
 }
@@ -30978,26 +38774,26 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": {
-"description": "When manual routing is set, the specified model will be used directly.",
+"description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.",
 "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode",
 "properties": {
 "modelName": {
-"description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).",
+"description": "The name of the model to use. Only public LLM models are accepted.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GenerationConfigThinkingConfig": {
-"description": "Config for thinking features.",
+"description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.",
 "id": "GoogleCloudAiplatformV1GenerationConfigThinkingConfig",
 "properties": {
 "includeThoughts": {
-"description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.",
+"description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.",
 "type": "boolean"
 },
 "thinkingBudget": {
-"description": "Optional. Indicates the thinking budget in tokens.",
+"description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.",
 "format": "int32",
 "type": "integer"
 }
@@ -31170,57 +38966,57 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingChunk": {
-"description": "Grounding chunk.",
+"description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.",
 "id": "GoogleCloudAiplatformV1GroundingChunk",
 "properties": {
 "maps": {
 "$ref": "GoogleCloudAiplatformV1GroundingChunkMaps",
-"description": "Grounding chunk from Google Maps."
+"description": "A grounding chunk from Google Maps. See the `Maps` message for details."
 },
 "retrievedContext": {
 "$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext",
-"description": "Grounding chunk from context retrieved by the retrieval tools."
+"description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details"
 },
 "web": {
 "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb",
-"description": "Grounding chunk from the web."
+"description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details."
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingChunkMaps": {
-"description": "Chunk from Google Maps.",
+"description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.",
 "id": "GoogleCloudAiplatformV1GroundingChunkMaps",
 "properties": {
 "placeAnswerSources": {
 "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources",
-"description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content."
+"description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content."
 },
 "placeId": {
-"description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.",
+"description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.",
 "type": "string"
 },
 "text": {
-"description": "Text of the place answer.",
+"description": "The text of the place answer.",
 "type": "string"
 },
 "title": {
-"description": "Title of the place.",
+"description": "The title of the place.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the place.",
+"description": "The URI of the place.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources": {
-"description": "Sources used to generate the place answer.",
+"description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.",
 "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources",
 "properties": {
 "reviewSnippets": {
-"description": "Snippets of reviews that are used to generate the answer.",
+"description": "Snippets of reviews that were used to generate the answer.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet"
 },
@@ -31230,7 +39026,7 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
-"description": "Encapsulates a review snippet.",
+"description": "A review snippet that is used to generate the answer.",
 "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
 "properties": {
 "googleMapsUri": {
@@ -31238,81 +39034,81 @@
 "type": "string"
 },
 "reviewId": {
-"description": "Id of the review referencing the place.",
+"description": "The ID of the review that is being referenced.",
 "type": "string"
 },
 "title": {
-"description": "Title of the review.",
+"description": "The title of the review.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": {
-"description": "Chunk from context retrieved by the retrieval tools.",
+"description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.",
 "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext",
 "properties": {
 "documentName": {
-"description": "Output only. The full document name for the referenced Vertex AI Search document.",
+"description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.",
 "readOnly": true,
 "type": "string"
 },
 "ragChunk": {
 "$ref": "GoogleCloudAiplatformV1RagChunk",
-"description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
+"description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used."
 },
 "text": {
-"description": "Text of the attribution.",
+"description": "The content of the retrieved data source.",
 "type": "string"
 },
 "title": {
-"description": "Title of the attribution.",
+"description": "The title of the retrieved data source.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the attribution.",
+"description": "The URI of the retrieved data source.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingChunkWeb": {
-"description": "Chunk from the web.",
+"description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.",
 "id": "GoogleCloudAiplatformV1GroundingChunkWeb",
 "properties": {
 "domain": {
-"description": "Domain of the (original) URI.",
+"description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.",
 "type": "string"
 },
 "title": {
-"description": "Title of the chunk.",
+"description": "The title of the web page that contains the evidence.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the chunk.",
+"description": "The URI of the web page that contains the evidence.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingMetadata": {
-"description": "Metadata returned to client when grounding is enabled.",
+"description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.",
 "id": "GoogleCloudAiplatformV1GroundingMetadata",
 "properties": {
 "googleMapsWidgetContextToken": {
-"description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.",
+"description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.",
 "readOnly": true,
 "type": "string"
 },
 "groundingChunks": {
-"description": "List of supporting references retrieved from specified grounding source.",
+"description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1GroundingChunk"
 },
 "type": "array"
 },
 "groundingSupports": {
-"description": "Optional. List of grounding support.",
+"description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1GroundingSupport"
 },
@@ -31320,15 +39116,15 @@
 },
 "retrievalMetadata": {
 "$ref": "GoogleCloudAiplatformV1RetrievalMetadata",
-"description": "Optional. Output only. Retrieval metadata.",
+"description": "Optional. Output only. Metadata related to the retrieval grounding source.",
 "readOnly": true
 },
 "searchEntryPoint": {
 "$ref": "GoogleCloudAiplatformV1SearchEntryPoint",
-"description": "Optional. Google search entry for the following-up web searches."
+"description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search."
 },
 "sourceFlaggingUris": {
-"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
+"description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri"
 },
@@ -31336,7 +39132,7 @@
 "type": "array"
 },
 "webSearchQueries": {
-"description": "Optional. Web search queries for the following-up web search.",
+"description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.",
 "items": {
 "type": "string"
 },
@@ -31346,26 +39142,26 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": {
-"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.",
+"description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.",
 "id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri",
 "properties": {
 "flagContentUri": {
-"description": "A link where users can flag a problem with the source (place or review).",
+"description": "The URI that can be used to flag the content.",
 "type": "string"
 },
 "sourceId": {
-"description": "Id of the place or review.",
+"description": "The ID of the place or review.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1GroundingSupport": {
-"description": "Grounding support.",
+"description": "A collection of supporting references for a segment of the model's response.",
 "id": "GoogleCloudAiplatformV1GroundingSupport",
 "properties": {
 "confidenceScores": {
-"description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.",
+"description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.",
 "items": {
 "format": "float",
 "type": "number"
@@ -31373,7 +39169,7 @@
 "type": "array"
 },
 "groundingChunkIndices": {
-"description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
+"description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.",
 "items": {
 "format": "int32",
 "type": "integer"
@@ -31382,7 +39178,7 @@
 },
 "segment": {
 "$ref": "GoogleCloudAiplatformV1Segment",
-"description": "Segment of the content this support belongs to."
+"description": "The content segment that this support message applies to."
 }
 },
 "type": "object"
@@ -31532,12 +39328,48 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1ImageConfig": {
-"description": "Config for image generation features.",
+"description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.",
 "id": "GoogleCloudAiplatformV1ImageConfig",
 "properties": {
 "aspectRatio": {
 "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"",
 "type": "string"
+},
+"imageOutputOptions": {
+"$ref": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions",
+"description": "Optional. The image output format for generated images."
+},
+"personGeneration": {
+"description": "Optional. Controls whether the model can generate people.",
+"enum": [
+"PERSON_GENERATION_UNSPECIFIED",
+"ALLOW_ALL",
+"ALLOW_ADULT",
+"ALLOW_NONE"
+],
+"enumDescriptions": [
+"The default behavior is unspecified. The model will decide whether to generate images of people.",
+"Allows the model to generate images of people, including adults and children.",
+"Allows the model to generate images of adults, but not children.",
+"Prevents the model from generating images of people."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1ImageConfigImageOutputOptions": {
+"description": "The image output format for generated images.",
+"id": "GoogleCloudAiplatformV1ImageConfigImageOutputOptions",
+"properties": {
+"compressionQuality": {
+"description": "Optional. The compression quality of the output image.",
+"format": "int32",
+"type": "integer"
+},
+"mimeType": {
+"description": "Optional. The image format that the output should be saved as.",
+"type": "string"
 }
 },
 "type": "object"
@@ -33448,18 +41280,18 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1LogprobsResult": {
-"description": "Logprobs Result",
+"description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.",
 "id": "GoogleCloudAiplatformV1LogprobsResult",
 "properties": {
 "chosenCandidates": {
-"description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
+"description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate"
 },
 "type": "array"
 },
 "topCandidates": {
-"description": "Length = total number of decoding steps.",
+"description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates"
 },
@@ -33469,20 +41301,20 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1LogprobsResultCandidate": {
-"description": "Candidate for the logprobs token and score.",
+"description": "A single token and its associated log probability.",
 "id": "GoogleCloudAiplatformV1LogprobsResultCandidate",
 "properties": {
 "logProbability": {
-"description": "The candidate's log probability.",
+"description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.",
 "format": "float",
 "type": "number"
 },
 "token": {
-"description": "The candidate's token string value.",
+"description": "The token's string representation.",
 "type": "string"
 },
 "tokenId": {
-"description": "The candidate's token id value.",
+"description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.",
 "format": "int32",
 "type": "integer"
 }
@@ -33490,11 +41322,11 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1LogprobsResultTopCandidates": {
-"description": "Candidates with top log probabilities at each decoding step.",
+"description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.",
 "id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates",
 "properties": {
 "candidates": {
-"description": "Sorted by log probability in descending order.",
+"description": "The list of candidate tokens, sorted by log probability in descending order.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate"
 },
@@ -33850,6 +41682,10 @@ false
 "$ref": "GoogleCloudAiplatformV1BleuSpec",
 "description": "Spec for bleu metric."
 },
+"customCodeExecutionSpec": {
+"$ref": "GoogleCloudAiplatformV1CustomCodeExecutionSpec",
+"description": "Spec for Custom Code Execution metric."
+},
 "exactMatchSpec": {
 "$ref": "GoogleCloudAiplatformV1ExactMatchSpec",
 "description": "Spec for exact match metric."
@@ -34232,11 +42068,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1ModalityTokenCount": {
-"description": "Represents token counting info for a single modality.",
+"description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.",
 "id": "GoogleCloudAiplatformV1ModalityTokenCount",
 "properties": {
 "modality": {
-"description": "The modality associated with this token count.",
+"description": "The modality that this token count applies to.",
 "enum": [
 "MODALITY_UNSPECIFIED",
 "TEXT",
@@ -34246,17 +42082,17 @@ false
 "DOCUMENT"
 ],
 "enumDescriptions": [
-"Unspecified modality.",
-"Plain text.",
-"Image.",
-"Video.",
-"Audio.",
-"Document, e.g. PDF."
+"When a modality is not specified, it is treated as `TEXT`.",
+"The `Part` contains plain text.",
+"The `Part` contains an image.",
+"The `Part` contains a video.",
+"The `Part` contains audio.",
+"The `Part` contains a document, such as a PDF."
 ],
 "type": "string"
 },
 "tokenCount": {
-"description": "Number of tokens.",
+"description": "The number of tokens counted for this modality.",
 "format": "int32",
 "type": "integer"
 }
@@ -34468,15 +42304,15 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1ModelArmorConfig": {
-"description": "Configuration for Model Armor integrations of prompt and responses.",
+"description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.",
 "id": "GoogleCloudAiplatformV1ModelArmorConfig",
 "properties": {
 "promptTemplateName": {
-"description": "Optional. The name of the Model Armor template to use for prompt sanitization.",
+"description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.",
 "type": "string"
 },
 "responseTemplateName": {
-"description": "Optional. The name of the Model Armor template to use for response sanitization.",
+"description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.",
 "type": "string"
 }
 },
@@ -35462,7 +43298,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig": {
-"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.",
+"description": "Configuration for a multi-speaker text-to-speech request.",
 "id": "GoogleCloudAiplatformV1MultiSpeakerVoiceConfig",
 "properties": {
 "speakerVoiceConfigs": {
@@ -35518,7 +43354,7 @@ false
 "properties": {
 "deployedModel": {
 "$ref": "GoogleCloudAiplatformV1DeployedModel",
-"description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)"
+"description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only)"
 },
 "updateMask": {
 "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
@@ -37209,39 +45045,39 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1Part": {
-"description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
+"description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
 "id": "GoogleCloudAiplatformV1Part",
 "properties": {
 "codeExecutionResult": {
 "$ref": "GoogleCloudAiplatformV1CodeExecutionResult",
-"description": "Optional. Result of executing the [ExecutableCode]."
+"description": "Optional. The result of executing the ExecutableCode."
 },
 "executableCode": {
 "$ref": "GoogleCloudAiplatformV1ExecutableCode",
-"description": "Optional. Code generated by the model that is meant to be executed."
+"description": "Optional. Code generated by the model that is intended to be executed."
 },
 "fileData": {
 "$ref": "GoogleCloudAiplatformV1FileData",
-"description": "Optional. URI based data."
+"description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage."
 },
 "functionCall": {
 "$ref": "GoogleCloudAiplatformV1FunctionCall",
-"description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values."
+"description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function."
 },
 "functionResponse": {
 "$ref": "GoogleCloudAiplatformV1FunctionResponse",
-"description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
+"description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted."
 },
 "inlineData": {
 "$ref": "GoogleCloudAiplatformV1Blob",
-"description": "Optional. Inlined bytes data."
+"description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request."
 },
 "text": {
-"description": "Optional. Text part (can be code).",
+"description": "Optional. The text content of the part.",
 "type": "string"
 },
 "thought": {
-"description": "Optional. Indicates if the part is thought from the model.",
+"description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.",
 "type": "boolean"
 },
 "thoughtSignature": {
@@ -38011,11 +45847,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1PrebuiltVoiceConfig": {
-"description": "The configuration for the prebuilt speaker to use.",
+"description": "Configuration for a prebuilt voice.",
 "id": "GoogleCloudAiplatformV1PrebuiltVoiceConfig",
 "properties": {
 "voiceName": {
-"description": "The name of the preset voice to use.",
+"description": "The name of the prebuilt voice to use.",
 "type": "string"
 }
 },
@@ -38080,6 +45916,13 @@ false
 },
 "type": "array"
 },
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.",
+"type": "object"
+},
 "parameters": {
 "description": "The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.",
 "type": "any"
@@ -38164,6 +46007,143 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1PreferenceOptimizationDataStats": {
+"description": "Statistics computed for datasets used for preference optimization.",
+"id": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats",
+"properties": {
+"droppedExampleIndices": {
+"description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"droppedExampleReasons": {
+"description": "Output only. For each index in `dropped_example_indices`, the user-facing reason why the example was dropped.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"scoreVariancePerExampleDistribution": {
+"$ref": "GoogleCloudAiplatformV1DatasetDistribution",
+"description": "Output only. Dataset distributions for scores variance per example.",
+"readOnly": true
+},
+"scoresDistribution": {
+"$ref": "GoogleCloudAiplatformV1DatasetDistribution",
+"description": "Output only. Dataset distributions for scores.",
+"readOnly": true
+},
+"totalBillableTokenCount": {
+"description": "Output only. Number of billable tokens in the tuning dataset.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"tuningDatasetExampleCount": {
+"description": "Output only. Number of examples in the tuning dataset.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"tuningStepCount": {
+"description": "Output only. Number of tuning steps for this Tuning Job.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"userDatasetExamples": {
+"description": "Output only. Sample user examples in the training dataset.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1GeminiPreferenceExample"
+},
+"readOnly": true,
+"type": "array"
+},
+"userInputTokenDistribution": {
+"$ref": "GoogleCloudAiplatformV1DatasetDistribution",
+"description": "Output only. Dataset distributions for the user input tokens.",
+"readOnly": true
+},
+"userOutputTokenDistribution": {
+"$ref": "GoogleCloudAiplatformV1DatasetDistribution",
+"description": "Output only. Dataset distributions for the user output tokens.",
+"readOnly": true
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters": {
+"description": "Hyperparameters for Preference Optimization.",
+"id": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters",
+"properties": {
+"adapterSize": {
+"description": "Optional. Adapter size for preference optimization.",
+"enum": [
+"ADAPTER_SIZE_UNSPECIFIED",
+"ADAPTER_SIZE_ONE",
+"ADAPTER_SIZE_TWO",
+"ADAPTER_SIZE_FOUR",
+"ADAPTER_SIZE_EIGHT",
+"ADAPTER_SIZE_SIXTEEN",
+"ADAPTER_SIZE_THIRTY_TWO"
+],
+"enumDescriptions": [
+"Adapter size is unspecified.",
+"Adapter size 1.",
+"Adapter size 2.",
+"Adapter size 4.",
+"Adapter size 8.",
+"Adapter size 16.",
+"Adapter size 32."
+],
+"type": "string"
+},
+"beta": {
+"description": "Optional. Weight for KL Divergence regularization.",
+"format": "double",
+"type": "number"
+},
+"epochCount": {
+"description": "Optional. Number of complete passes the model makes over the entire training dataset during training.",
+"format": "int64",
+"type": "string"
+},
+"learningRateMultiplier": {
+"description": "Optional. Multiplier for adjusting the default learning rate.",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1PreferenceOptimizationSpec": {
+"description": "Tuning Spec for Preference Optimization.",
+"id": "GoogleCloudAiplatformV1PreferenceOptimizationSpec",
+"properties": {
+"exportLastCheckpointOnly": {
+"description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.",
+"type": "boolean"
+},
+"hyperParameters": {
+"$ref": "GoogleCloudAiplatformV1PreferenceOptimizationHyperParameters",
+"description": "Optional. Hyperparameters for Preference Optimization."
+},
+"trainingDatasetUri": {
+"description": "Required. Cloud Storage path to file containing training dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.",
+"type": "string"
+},
+"validationDatasetUri": {
+"description": "Optional. Cloud Storage path to file containing validation dataset for preference optimization tuning. The dataset must be formatted as a JSONL file.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1Presets": {
 "description": "Preset configuration for example-based explanations",
 "id": "GoogleCloudAiplatformV1Presets",
@@ -39461,6 +47441,16 @@ false
 "readOnly": true,
 "type": "string"
 },
+"satisfiesPzi": {
+"description": "Output only. Reserved for future use.",
+"readOnly": true,
+"type": "boolean"
+},
+"satisfiesPzs": {
+"description": "Output only. Reserved for future use.",
+"readOnly": true,
+"type": "boolean"
+},
 "updateTime": {
 "description": "Output only. Timestamp when this RagCorpus was last updated.",
 "format": "google-datetime",
@@ -39694,7 +47684,7 @@ false
 },
 "scaled": {
 "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigScaled",
-"description": "Sets the RagManagedDb to the Scaled tier."
+"description": "Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen."
 },
 "unprovisioned": {
 "$ref": "GoogleCloudAiplatformV1RagManagedDbConfigUnprovisioned",
@@ -40268,6 +48258,10 @@ false
 "serviceAccount": {
 "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.",
 "type": "string"
+},
+"sourceCodeSpec": {
+"$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec",
+"description": "Deploy from source code files with a defined entrypoint."
 }
 },
 "type": "object"
@@ -40332,7 +48326,7 @@ false
 "type": "string"
 },
 "pythonVersion": {
-"description": "Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.",
+"description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.",
 "type": "string"
 },
 "requirementsGcsUri": {
@@ -40342,6 +48336,56 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec": {
+"description": "Specification for deploying from source code.",
+"id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec",
+"properties": {
+"inlineSource": {
+"$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource",
+"description": "Source code is provided directly in the request."
+},
+"pythonSpec": {
+"$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec",
+"description": "Configuration for a Python application."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource": {
+"description": "Specifies source code provided as a byte stream.",
+"id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecInlineSource",
+"properties": {
+"sourceArchive": {
+"description": "Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.",
+"format": "byte",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec": {
+"description": "Specification for running a Python application from source.",
+"id": "GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpecPythonSpec",
+"properties": {
+"entrypointModule": {
+"description": "Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to \"agent\". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.",
+"type": "string"
+},
+"entrypointObject": {
+"description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\".",
+"type": "string"
+},
+"requirementsFile": {
+"description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\".",
+"type": "string"
+},
+"version": {
+"description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1RebaseTunedModelRequest": {
 "description": "Request message for GenAiTuningService.RebaseTunedModel.",
 "id": "GoogleCloudAiplatformV1RebaseTunedModelRequest",
@@ -40622,11 +48666,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1RetrievalMetadata": {
-"description": "Metadata related to retrieval in the grounding flow.",
+"description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.",
 "id": "GoogleCloudAiplatformV1RetrievalMetadata",
 "properties": {
 "googleSearchDynamicRetrievalScore": {
-"description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
+"description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.",
 "format": "float",
 "type": "number"
 }
@@ -41010,16 +49054,16 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1SafetyRating": {
-"description": "Safety rating corresponding to the generated content.",
+"description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.",
 "id": "GoogleCloudAiplatformV1SafetyRating",
 "properties": {
 "blocked": {
-"description": "Output only. Indicates whether the content was filtered out because of this rating.",
+"description": "Output only. Indicates whether the content was blocked because of this rating.",
 "readOnly": true,
 "type": "boolean"
 },
 "category": {
-"description": "Output only. Harm category.",
+"description": "Output only. The harm category of this rating.",
 "enum": [
 "HARM_CATEGORY_UNSPECIFIED",
 "HARM_CATEGORY_HATE_SPEECH",
@@ -41047,17 +49091,17 @@ false,
 false
 ],
 "enumDescriptions": [
-"The harm category is unspecified.",
-"The harm category is hate speech.",
-"The harm category is dangerous content.",
-"The harm category is harassment.",
-"The harm category is sexually explicit content.",
+"Default value. This value is unused.",
+"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.",
+"Content that promotes, facilitates, or enables dangerous activities.",
+"Abusive, threatening, or content intended to bully, torment, or ridicule.",
+"Content that contains sexually explicit material.",
 "Deprecated: Election filter is not longer supported. The harm category is civic integrity.",
-"The harm category is image hate.",
-"The harm category is image dangerous content.",
-"The harm category is image harassment.",
-"The harm category is image sexually explicit content.",
-"The harm category is for jailbreak prompts."
+"Images that contain hate speech.",
+"Images that contain dangerous content.",
+"Images that contain harassment.",
+"Images that contain sexually explicit content.",
+"Prompts designed to bypass safety filters."
 ],
 "readOnly": true,
 "type": "string"
@@ -41073,18 +49117,18 @@ false
 "OFF"
 ],
 "enumDescriptions": [
-"Unspecified harm block threshold.",
-"Block low threshold and above (i.e. block more).",
-"Block medium threshold and above.",
-"Block only high threshold (i.e. block less).",
-"Block none.",
-"Turn off the safety filter."
+"The harm block threshold is unspecified.",
+"Block content with a low harm probability or higher.",
+"Block content with a medium harm probability or higher.",
+"Block content with a high harm probability.",
+"Do not block any content, regardless of its harm probability.",
+"Turn off the safety filter entirely."
 ],
 "readOnly": true,
 "type": "string"
 },
 "probability": {
-"description": "Output only. Harm probability levels in the content.",
+"description": "Output only. The probability of harm for this category.",
 "enum": [
 "HARM_PROBABILITY_UNSPECIFIED",
 "NEGLIGIBLE",
@@ -41093,23 +49137,23 @@ false
 "HIGH"
 ],
 "enumDescriptions": [
-"Harm probability unspecified.",
-"Negligible level of harm.",
-"Low level of harm.",
-"Medium level of harm.",
-"High level of harm."
+"The harm probability is unspecified.",
+"The harm probability is negligible.",
+"The harm probability is low.",
+"The harm probability is medium.",
+"The harm probability is high."
 ],
 "readOnly": true,
 "type": "string"
 },
 "probabilityScore": {
-"description": "Output only. Harm probability score.",
+"description": "Output only. The probability score of harm for this category.",
 "format": "float",
 "readOnly": true,
 "type": "number"
 },
 "severity": {
-"description": "Output only. Harm severity levels in the content.",
+"description": "Output only. The severity of harm for this category.",
 "enum": [
 "HARM_SEVERITY_UNSPECIFIED",
 "HARM_SEVERITY_NEGLIGIBLE",
@@ -41118,17 +49162,17 @@ false
 "HARM_SEVERITY_HIGH"
 ],
 "enumDescriptions": [
-"Harm severity unspecified.",
-"Negligible level of harm severity.",
-"Low level of harm severity.",
-"Medium level of harm severity.",
-"High level of harm severity."
+"The harm severity is unspecified.",
+"The harm severity is negligible.",
+"The harm severity is low.",
+"The harm severity is medium.",
+"The harm severity is high."
 ],
 "readOnly": true,
 "type": "string"
 },
 "severityScore": {
-"description": "Output only. Harm severity score.",
+"description": "Output only. The severity score of harm for this category.",
 "format": "float",
 "readOnly": true,
 "type": "number"
@@ -41161,11 +49205,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1SafetySetting": {
-"description": "Safety settings.",
+"description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.",
 "id": "GoogleCloudAiplatformV1SafetySetting",
 "properties": {
 "category": {
-"description": "Required. Harm category.",
+"description": "Required. The harm category to be blocked.",
 "enum": [
 "HARM_CATEGORY_UNSPECIFIED",
 "HARM_CATEGORY_HATE_SPEECH",
@@ -41193,22 +49237,22 @@ false,
 false
 ],
 "enumDescriptions": [
-"The harm category is unspecified.",
-"The harm category is hate speech.",
-"The harm category is dangerous content.",
-"The harm category is harassment.",
-"The harm category is sexually explicit content.",
+"Default value. This value is unused.",
+"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.",
+"Content that promotes, facilitates, or enables dangerous activities.",
+"Abusive, threatening, or content intended to bully, torment, or ridicule.",
+"Content that contains sexually explicit material.",
 "Deprecated: Election filter is not longer supported. The harm category is civic integrity.",
-"The harm category is image hate.",
-"The harm category is image dangerous content.",
-"The harm category is image harassment.",
-"The harm category is image sexually explicit content.",
-"The harm category is for jailbreak prompts."
+"Images that contain hate speech.",
+"Images that contain dangerous content.",
+"Images that contain harassment.",
+"Images that contain sexually explicit content.",
+"Prompts designed to bypass safety filters."
 ],
 "type": "string"
 },
 "method": {
-"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.",
+"description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.",
 "enum": [
 "HARM_BLOCK_METHOD_UNSPECIFIED",
 "SEVERITY",
@@ -41222,7 +49266,7 @@ false
 "type": "string"
 },
 "threshold": {
-"description": "Required. The harm block threshold.",
+"description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.",
 "enum": [
 "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
 "BLOCK_LOW_AND_ABOVE",
@@ -41232,12 +49276,12 @@ false
 "OFF"
 ],
 "enumDescriptions": [
-"Unspecified harm block threshold.",
-"Block low threshold and above (i.e. block more).",
-"Block medium threshold and above.",
-"Block only high threshold (i.e. block less).",
-"Block none.",
-"Turn off the safety filter."
+"The harm block threshold is unspecified.",
+"Block content with a low harm probability or higher.",
+"Block content with a medium harm probability or higher.",
+"Block content with a high harm probability.",
+"Do not block any content, regardless of its harm probability.",
+"Turn off the safety filter entirely."
 ],
 "type": "string"
 }
@@ -45842,15 +53886,15 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1SearchEntryPoint": {
-"description": "Google search entry point.",
+"description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.",
 "id": "GoogleCloudAiplatformV1SearchEntryPoint",
 "properties": {
 "renderedContent": {
-"description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
+"description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.",
 "type": "string"
 },
 "sdkBlob": {
-"description": "Optional. Base64 encoded JSON representing array of tuple.",
+"description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.",
 "format": "byte",
 "type": "string"
 }
@@ -46058,29 +54102,29 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1Segment": {
-"description": "Segment of the content.",
+"description": "A segment of the content.",
 "id": "GoogleCloudAiplatformV1Segment",
 "properties": {
 "endIndex": {
-"description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
+"description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "partIndex": {
-"description": "Output only. The index of a Part object within its parent Content object.",
+"description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "startIndex": {
-"description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
+"description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "text": {
-"description": "Output only. The text corresponding to the segment from the response.",
+"description": "Output only. The text of the segment.",
 "readOnly": true,
 "type": "string"
 }
@@ -46246,7 +54290,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1SpeakerVoiceConfig": {
-"description": "Configuration for a single speaker in a multi speaker setup.",
+"description": "Configuration for a single speaker in a multi-speaker setup.",
 "id": "GoogleCloudAiplatformV1SpeakerVoiceConfig",
 "properties": {
 "speaker": {
@@ -46347,11 +54391,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1SpeechConfig": {
-"description": "The speech generation config.",
+"description": "Configuration for speech generation.",
 "id": "GoogleCloudAiplatformV1SpeechConfig",
 "properties": {
 "languageCode": {
-"description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.",
+"description": "Optional. The language code (ISO 639-1) for the speech synthesis.",
 "type": "string"
 },
 "multiSpeakerVoiceConfig": {
@@ -46360,7 +54404,7 @@ false
 },
 "voiceConfig": {
 "$ref": "GoogleCloudAiplatformV1VoiceConfig",
-"description": "The configuration for the speaker to use."
+"description": "The configuration for the voice to use."
 }
 },
 "type": "object"
@@ -48248,6 +56292,10 @@ false
 "$ref": "GoogleCloudAiplatformV1ToolCodeExecution",
 "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation."
 },
+"computerUse": {
+"$ref": "GoogleCloudAiplatformV1ToolComputerUse",
+"description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations."
+},
 "enterpriseWebSearch": {
 "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch",
 "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance."
@@ -48371,6 +56419,32 @@ false
 "properties": {},
 "type": "object"
 },
+"GoogleCloudAiplatformV1ToolComputerUse": {
+"description": "Tool to support computer use.",
+"id": "GoogleCloudAiplatformV1ToolComputerUse",
+"properties": {
+"environment": {
+"description": "Required. The environment being operated.",
+"enum": [
+"ENVIRONMENT_UNSPECIFIED",
+"ENVIRONMENT_BROWSER"
+],
+"enumDescriptions": [
+"Defaults to browser.",
+"Operates in a web browser."
+],
+"type": "string"
+},
+"excludedPredefinedFunctions": {
+"description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1ToolConfig": {
 "description": "Tool config. This config is shared for all tools provided in the request.",
 "id": "GoogleCloudAiplatformV1ToolConfig",
@@ -49370,6 +57444,11 @@ false
 "description": "The tuning data statistic values for TuningJob.",
 "id": "GoogleCloudAiplatformV1TuningDataStats",
 "properties": {
+"preferenceOptimizationDataStats": {
+"$ref": "GoogleCloudAiplatformV1PreferenceOptimizationDataStats",
+"description": "Output only. Statistics for preference optimization.",
+"readOnly": true
+},
 "supervisedTuningDataStats": {
 "$ref": "GoogleCloudAiplatformV1SupervisedTuningDataStats",
 "description": "The SFT Tuning data stats."
@@ -49431,6 +57510,10 @@ false
 "$ref": "GoogleCloudAiplatformV1PreTunedModel",
 "description": "The pre-tuned model for continuous tuning."
 },
+"preferenceOptimizationSpec": {
+"$ref": "GoogleCloudAiplatformV1PreferenceOptimizationSpec",
+"description": "Tuning Spec for Preference Optimization."
+},
 "serviceAccount": {
 "description": "The service account that the tuningJob workload runs as. If not specified, the Vertex AI Secure Fine-Tuned Service Agent in the project will be used. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.",
 "type": "string"
@@ -49901,11 +57984,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1UrlContextMetadata": {
-"description": "Metadata related to url context retrieval tool.",
+"description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.",
 "id": "GoogleCloudAiplatformV1UrlContextMetadata",
 "properties": {
 "urlMetadata": {
-"description": "Output only. List of url context.",
+"description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1UrlMetadata"
 },
@@ -49916,15 +57999,15 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1UrlMetadata": {
-"description": "Context of the a single url retrieval.",
+"description": "The metadata for a single URL retrieval.",
 "id": "GoogleCloudAiplatformV1UrlMetadata",
 "properties": {
 "retrievedUrl": {
-"description": "Retrieved url by the tool.",
+"description": "The URL retrieved by the tool.",
 "type": "string"
 },
 "urlRetrievalStatus": {
-"description": "Status of the url retrieval.",
+"description": "The status of the URL retrieval.",
 "enum": [
 "URL_RETRIEVAL_STATUS_UNSPECIFIED",
 "URL_RETRIEVAL_STATUS_SUCCESS",
@@ -49932,9 +58015,96 @@ false
 ],
 "enumDescriptions": [
 "Default value. This value is unused.",
-"Url retrieval is successful.",
-"Url retrieval is failed due to error."
+"The URL was retrieved successfully.",
+"The URL retrieval failed."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1UsageMetadata": {
+"description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.",
+"id": "GoogleCloudAiplatformV1UsageMetadata",
+"properties": {
+"cacheTokensDetails": {
+"description": "Output only. A detailed breakdown of the token count for each modality in the cached content.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"cachedContentTokenCount": {
+"description": "Output only. The number of tokens in the cached content that was used for this request.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"candidatesTokenCount": {
+"description": "The total number of tokens in the generated candidates.",
+"format": "int32",
+"type": "integer"
+},
+"candidatesTokensDetails": {
+"description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"promptTokenCount": {
+"description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.",
+"format": "int32",
+"type": "integer"
+},
+"promptTokensDetails": {
+"description": "Output only. A detailed breakdown of the token count for each modality in the prompt.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"thoughtsTokenCount": {
+"description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"toolUsePromptTokenCount": {
+"description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"toolUsePromptTokensDetails": {
+"description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"totalTokenCount": {
+"description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.",
+"format": "int32",
+"type": "integer"
+},
+"trafficType": {
+"description": "Output only. The traffic type for this request.",
+"enum": [
+"TRAFFIC_TYPE_UNSPECIFIED",
+"ON_DEMAND",
+"PROVISIONED_THROUGHPUT"
+],
+"enumDescriptions": [
+"Unspecified request traffic type.",
+"Type for Pay-As-You-Go traffic.",
+"Type for Provisioned Throughput traffic."
 ],
+"readOnly": true,
 "type": "string"
 }
 },
@@ -50086,7 +58256,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1VideoMetadata": {
-"description": "Metadata describes the input video content.",
+"description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.",
 "id": "GoogleCloudAiplatformV1VideoMetadata",
 "properties": {
 "endOffset": {
@@ -50095,7 +58265,7 @@ false
 "type": "string"
 },
 "fps": {
-"description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].",
+"description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].",
 "format": "double",
 "type": "number"
 },
@@ -50108,12 +58278,12 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1VoiceConfig": {
-"description": "The configuration for the voice to use.",
+"description": "Configuration for a voice.",
 "id": "GoogleCloudAiplatformV1VoiceConfig",
 "properties": {
 "prebuiltVoiceConfig": {
 "$ref": "GoogleCloudAiplatformV1PrebuiltVoiceConfig",
-"description": "The configuration for the prebuilt voice to use."
+"description": "The configuration for a prebuilt voice."
 }
 },
 "type": "object"
diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
index 37bec44163..cfc7fc61ad 100644
--- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json
@@ -106,6 +106,11 @@
 },
 {
 "description": "Locational Endpoint",
+"endpointUrl": "https://europe-west15-aiplatform.googleapis.com/",
+"location": "europe-west15"
+},
+{
+"description": "Locational Endpoint",
 "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/",
 "location": "europe-west2"
 },
@@ -335,69 +340,106 @@
 },
 "protocol": "rest",
 "resources": {
-"batchPredictionJobs": {
+"agents": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.",
-"flatPath": "v1beta1/batchPredictionJobs",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.batchPredictionJobs.create",
-"parameterOrder": [],
+"id": "aiplatform.agents.operations.cancel",
+"parameterOrder": [
+"name"
+],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^agents/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/batchPredictionJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.agents.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^agents/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a BatchPredictionJob",
-"flatPath": "v1beta1/batchPredictionJobs/{batchPredictionJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.batchPredictionJobs.get",
+"id": "aiplatform.agents.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^batchPredictionJobs/[^/]+$",
+"pattern": "^agents/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists BatchPredictionJobs in a Location.",
-"flatPath": "v1beta1/batchPredictionJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/agents/{agentsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.batchPredictionJobs.list",
-"parameterOrder": [],
+"id": "aiplatform.agents.operations.list",
+"parameterOrder": [
+"name"
+],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^agents/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -405,129 +447,157 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/agents/{agentsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.agents.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^agents/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/batchPredictionJobs",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
 },
-"datasets": {
+"apps": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a Dataset.",
-"flatPath": "v1beta1/datasets",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.datasets.create",
-"parameterOrder": [],
+"id": "aiplatform.apps.operations.cancel",
+"parameterOrder": [
+"name"
+],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^apps/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/datasets",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a Dataset.",
-"flatPath": "v1beta1/datasets/{datasetsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.datasets.delete",
+"id": "aiplatform.apps.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^datasets/[^/]+$",
+"pattern": "^apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Dataset.",
-"flatPath": "v1beta1/datasets/{datasetsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.datasets.get",
+"id": "aiplatform.apps.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource.",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^datasets/[^/]+$",
+"pattern": "^apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Datasets in a Location.",
-"flatPath": "v1beta1/datasets",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/apps/{appsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.datasets.list",
-"parameterOrder": [],
+"id": "aiplatform.apps.operations.list",
+"parameterOrder": [
+"name"
+],
 "parameters": {
 "filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^apps/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -541,651 +611,630 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "query",
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/datasets",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a Dataset.",
-"flatPath": "v1beta1/datasets/{datasetsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.datasets.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/apps/{appsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.apps.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^datasets/[^/]+$",
+"pattern": "^apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"datasetVersions": {
+"batchPredictionJobs": {
 "methods": {
 "create": {
-"description": "Create a version from a Dataset.",
-"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions",
+"description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.",
+"flatPath": "v1beta1/batchPredictionJobs",
 "httpMethod": "POST",
-"id": "aiplatform.datasets.datasetVersions.create",
-"parameterOrder": [
-"parent"
-],
+"id": "aiplatform.batchPredictionJobs.create",
+"parameterOrder": [],
 "parameters": {
 "parent": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^datasets/[^/]+$",
-"required": true,
+"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/datasetVersions",
+"path": "v1beta1/batchPredictionJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a Dataset version.",
-"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.datasets.datasetVersions.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
-"location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
-"required": true,
-"type": "string"
-}
+"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
 },
-"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Dataset version.",
-"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"description": "Gets a BatchPredictionJob",
+"flatPath": "v1beta1/batchPredictionJobs/{batchPredictionJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.datasets.datasetVersions.get",
+"id": "aiplatform.batchPredictionJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^batchPredictionJobs/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
+"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists DatasetVersions in a Dataset.",
-"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions",
+"description": "Lists BatchPredictionJobs in a Location.",
+"flatPath": "v1beta1/batchPredictionJobs",
 "httpMethod": "GET",
-"id": "aiplatform.datasets.datasetVersions.list",
-"parameterOrder": [
-"parent"
-],
+"id": "aiplatform.batchPredictionJobs.list",
+"parameterOrder": [],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^datasets/[^/]+$",
-"required": true,
+"description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`",
+"location": "query",
 "type": "string"
 },
 "readMask": {
-"description": "Optional. Mask specifying which fields to read.",
+"description": "Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/datasetVersions",
+"path": "v1beta1/batchPredictionJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"patch": {
-"description": "Updates a DatasetVersion.",
-"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.datasets.datasetVersions.patch",
+"customJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.customJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"restore": {
-"description": "Restores a dataset version.",
-"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
-"httpMethod": "GET",
-"id": "aiplatform.datasets.datasetVersions.restore",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.customJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:restore",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"endpoints": {
-"methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1beta1/endpoints/{endpointsId}:computeTokens",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.computeTokens",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.customJobs.operations.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:computeTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1beta1/endpoints/{endpointsId}:countTokens",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.countTokens",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/customJobs/{customJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.customJobs.operations.list",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^customJobs/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1beta1/endpoints/{endpointsId}:fetchPredictOperation",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/customJobs/{customJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.endpoints.fetchPredictOperation",
+"id": "aiplatform.customJobs.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:fetchPredictOperation",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1beta1/endpoints/{endpointsId}:generateContent",
+"dataLabelingJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.endpoints.generateContent",
+"id": "aiplatform.dataLabelingJobs.operations.cancel",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+model}:generateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1beta1/endpoints/{endpointsId}:predict",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.predict",
-"parameterOrder": [
-"endpoint"
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.dataLabelingJobs.operations.delete",
+"parameterOrder": [
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:predict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1beta1/endpoints/{endpointsId}:predictLongRunning",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.predictLongRunning",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.dataLabelingJobs.operations.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:predictLongRunning",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1beta1/endpoints/{endpointsId}:streamGenerateContent",
-"httpMethod": "POST",
-"id": "aiplatform.endpoints.streamGenerateContent",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.dataLabelingJobs.operations.list",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^dataLabelingJobs/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"chat": {
-"methods": {
-"completions": {
-"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
-"flatPath": "v1beta1/endpoints/{endpointsId}/chat/completions",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.endpoints.chat.completions",
+"id": "aiplatform.dataLabelingJobs.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^endpoints/[^/]+$",
+"pattern": "^dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}/chat/completions",
-"request": {
-"$ref": "GoogleApiHttpBody"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
 }
 }
 },
-"media": {
+"datasets": {
 "methods": {
-"upload": {
-"description": "Upload a file into a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload",
+"create": {
+"description": "Creates a Dataset.",
+"flatPath": "v1beta1/datasets",
 "httpMethod": "POST",
-"id": "aiplatform.media.upload",
-"mediaUpload": {
-"accept": [
-"*/*"
-],
-"protocols": {
-"simple": {
-"multipart": true,
-"path": "/upload/v1beta1/{+parent}/ragFiles:upload"
-}
-}
-},
-"parameterOrder": [
-"parent"
-],
+"id": "aiplatform.datasets.create",
+"parameterOrder": [],
 "parameters": {
 "parent": {
-"description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
-"required": true,
+"description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/ragFiles:upload",
+"path": "v1beta1/datasets",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest"
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
-],
-"supportsMediaUpload": true
-}
-}
+]
 },
-"projects": {
-"methods": {
-"fetchPublisherModelConfig": {
-"description": "Fetches the configs of publisher models.",
-"flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig",
-"httpMethod": "GET",
-"id": "aiplatform.projects.fetchPublisherModelConfig",
+"delete": {
+"description": "Deletes a Dataset.",
+"flatPath": "v1beta1/datasets/{datasetsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
+"description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:fetchPublisherModelConfig",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getCacheConfig": {
-"description": "Gets a GenAI cache config.",
-"flatPath": "v1beta1/projects/{projectsId}/cacheConfig",
+"get": {
+"description": "Gets a Dataset.",
+"flatPath": "v1beta1/datasets/{datasetsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.getCacheConfig",
+"id": "aiplatform.datasets.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"description": "Required. The name of the Dataset resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/cacheConfig$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CacheConfig"
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setPublisherModelConfig": {
-"description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.",
-"flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig",
-"httpMethod": "POST",
-"id": "aiplatform.projects.setPublisherModelConfig",
-"parameterOrder": [
-"name"
-],
+"list": {
+"description": "Lists Datasets in a Location.",
+"flatPath": "v1beta1/datasets",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.list",
+"parameterOrder": [],
 "parameters": {
-"name": {
-"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
-"location": "path",
-"pattern": "^projects/[^/]+$",
-"required": true,
+"filter": {
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`",
+"location": "query",
 "type": "string"
-}
 },
-"path": "v1beta1/{+name}:setPublisherModelConfig",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest"
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`",
+"location": "query",
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/datasets",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"updateCacheConfig": {
-"description": "Updates a cache config.",
-"flatPath": "v1beta1/projects/{projectsId}/cacheConfig",
+"patch": {
+"description": "Updates a Dataset.",
+"flatPath": "v1beta1/datasets/{datasetsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.updateCacheConfig",
+"id": "aiplatform.datasets.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
+"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/cacheConfig$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1CacheConfig"
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -1193,85 +1242,78 @@
 }
 },
 "resources": {
-"locations": {
+"annotationSpecs": {
+"resources": {
+"operations": {
 "methods": {
-"augmentPrompt": {
-"description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.augmentPrompt",
+"id": "aiplatform.datasets.annotationSpecs.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}:augmentPrompt",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"corroborateContent": {
-"description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.corroborateContent",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.annotationSpecs.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}:corroborateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deploy": {
-"description": "Deploys a model to a new endpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploy",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.annotationSpecs.operations.get",
 "parameterOrder": [
-"destination"
+"name"
 ],
 "parameters": {
-"destination": {
-"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+destination}:deploy",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeployRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -1279,321 +1321,238 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deployPublisherModel": {
-"deprecated": true,
-"description": "Deploys publisher models.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.deployPublisherModel",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.annotationSpecs.operations.list",
 "parameterOrder": [
-"destination"
+"name"
 ],
 "parameters": {
-"destination": {
-"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+destination}:deployPublisherModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"evaluateDataset": {
-"description": "Evaluates a dataset based on a set of given metrics.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluateDataset",
-"parameterOrder": [
-"location"
-],
-"parameters": {
-"location": {
-"description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
 "type": "string"
-}
 },
-"path": "v1beta1/{+location}:evaluateDataset",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"evaluateInstances": {
-"description": "Evaluates instances based on a given metric.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluateInstances",
+"id": "aiplatform.datasets.annotationSpecs.operations.wait",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+location}:evaluateInstances",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"generateInstanceRubrics": {
-"description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics",
+"dataItems": {
+"resources": {
+"annotations": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.generateInstanceRubrics",
+"id": "aiplatform.datasets.dataItems.annotations.operations.cancel",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+location}:generateInstanceRubrics",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateSyntheticData": {
-"description": "Generates synthetic data based on the provided configuration.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.generateSyntheticData",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.datasets.dataItems.annotations.operations.delete",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+location}:generateSyntheticData",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets information about a location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.get",
+"id": "aiplatform.datasets.dataItems.annotations.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Resource name for the location.",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudLocationLocation"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getRagEngineConfig": {
-"description": "Gets a RagEngineConfig.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.getRagEngineConfig",
+"id": "aiplatform.datasets.dataItems.annotations.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists information about the supported locations for this service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.list",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
 "filter": {
-"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "name": {
-"description": "The resource that owns the locations collection, if applicable.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
 "required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of results to return. If not set, the service selects a default.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
-}
-},
-"path": "v1beta1/{+name}/locations",
-"response": {
-"$ref": "GoogleCloudLocationListLocationsResponse"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"recommendSpec": {
-"description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.recommendSpec",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}:recommendSpec",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest"
-},
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"retrieveContexts": {
-"description": "Retrieves relevant contexts for a query.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.retrieveContexts",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}:retrieveContexts",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"updateRagEngineConfig": {
-"description": "Updates a RagEngineConfig.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.updateRagEngineConfig",
+"id": "aiplatform.datasets.dataItems.annotations.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -1601,17 +1560,17 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"agents": {
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.agents.operations.cancel",
+"id": "aiplatform.datasets.dataItems.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -1619,7 +1578,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -1634,9 +1593,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.agents.operations.delete",
+"id": "aiplatform.datasets.dataItems.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -1644,7 +1603,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -1659,9 +1618,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.agents.operations.get",
+"id": "aiplatform.datasets.dataItems.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -1669,7 +1628,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -1684,9 +1643,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.agents.operations.list",
+"id": "aiplatform.datasets.dataItems.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -1699,7 +1658,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -1730,9 +1689,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.agents.operations.wait",
+"id": "aiplatform.datasets.dataItems.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -1740,7 +1699,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -1763,288 +1722,303 @@
 }
 }
 },
-"apps": {
-"resources": {
-"operations": {
+"datasetVersions": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel",
+"create": {
+"description": "Create a version from a Dataset.",
+"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.apps.operations.cancel",
+"id": "aiplatform.datasets.datasetVersions.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"parent": {
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+parent}/datasetVersions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}",
+"description": "Deletes a Dataset version.",
+"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.apps.operations.delete",
+"id": "aiplatform.datasets.datasetVersions.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}",
+"description": "Gets a Dataset version.",
+"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.apps.operations.get",
+"id": "aiplatform.datasets.datasetVersions.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations",
+"description": "Lists DatasetVersions in a Dataset.",
+"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.apps.operations.list",
+"id": "aiplatform.datasets.datasetVersions.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Optional. The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"parent": {
+"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/datasetVersions",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.apps.operations.wait",
+"patch": {
+"description": "Updates a DatasetVersion.",
+"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.datasets.datasetVersions.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"batchPredictionJobs": {
-"methods": {
-"cancel": {
-"description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.batchPredictionJobs.cancel",
+"restore": {
+"description": "Restores a dataset version.",
+"flatPath": "v1beta1/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
+"httpMethod": "GET",
+"id": "aiplatform.datasets.datasetVersions.restore",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"pattern": "^datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest"
-},
+"path": "v1beta1/{+name}:restore",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"create": {
-"description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.batchPredictionJobs.create",
+"id": "aiplatform.datasets.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/batchPredictionJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.batchPredictionJobs.delete",
+"id": "aiplatform.datasets.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a BatchPredictionJob",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.batchPredictionJobs.get",
+"id": "aiplatform.datasets.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists BatchPredictionJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.batchPredictionJobs.list",
+"id": "aiplatform.datasets.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -2052,27 +2026,50 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/datasets/{datasetsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.datasets.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/batchPredictionJobs",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -2080,49 +2077,48 @@
 }
 }
 },
-"cachedContents": {
+"savedQueries": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.cachedContents.create",
+"id": "aiplatform.datasets.savedQueries.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The parent resource where the cached content will be created",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/cachedContents",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes cached content",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.cachedContents.delete",
+"id": "aiplatform.datasets.savedQueries.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name referring to the cached content",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2136,125 +2132,135 @@
 ]
 },
 "get": {
-"description": "Gets cached content configurations",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.cachedContents.get",
+"id": "aiplatform.datasets.savedQueries.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name referring to the cached content",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists cached contents in a project",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.cachedContents.list",
+"id": "aiplatform.datasets.savedQueries.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The parent, which owns this collection of cached contents.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/cachedContents",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListCachedContentsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates cached content configurations",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.cachedContents.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.datasets.savedQueries.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
+"pattern": "^datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The list of fields to update.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
+}
+}
 },
-"customJobs": {
+"deploymentResourcePools": {
+"resources": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.cancel",
+"id": "aiplatform.deploymentResourcePools.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelCustomJobRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -2262,98 +2268,77 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.create",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.deploymentResourcePools.operations.delete",
 "parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/customJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CustomJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1CustomJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a CustomJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.customJobs.delete",
-"parameterOrder": [
-"name"
+"name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a CustomJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.get",
+"id": "aiplatform.deploymentResourcePools.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CustomJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists CustomJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.list",
+"id": "aiplatform.deploymentResourcePools.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -2361,41 +2346,68 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.deploymentResourcePools.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/customJobs",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"edgeDevices": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.operations.cancel",
+"id": "aiplatform.edgeDevices.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -2403,7 +2415,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2418,9 +2430,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.customJobs.operations.delete",
+"id": "aiplatform.edgeDevices.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -2428,7 +2440,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2443,9 +2455,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.operations.get",
+"id": "aiplatform.edgeDevices.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -2453,7 +2465,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2468,9 +2480,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations",
+"flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.customJobs.operations.list",
+"id": "aiplatform.edgeDevices.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -2483,7 +2495,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
+"pattern": "^edgeDevices/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2514,9 +2526,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.customJobs.operations.wait",
+"id": "aiplatform.edgeDevices.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -2524,7 +2536,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
+"pattern": "^edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2547,175 +2559,252 @@
 }
 }
 },
-"dataLabelingJobs": {
+"endpoints": {
 "methods": {
-"cancel": {
-"description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel",
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1beta1/endpoints/{endpointsId}:computeTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.cancel",
+"id": "aiplatform.endpoints.computeTokens",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+endpoint}:computeTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest"
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
 },
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a DataLabelingJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1beta1/endpoints/{endpointsId}:countTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.create",
+"id": "aiplatform.endpoints.countTokens",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/dataLabelingJobs",
+"path": "v1beta1/{+endpoint}:countTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob"
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob"
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"delete": {
-"description": "Deletes a DataLabelingJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.dataLabelingJobs.delete",
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1beta1/endpoints/{endpointsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.fetchPredictOperation",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"get": {
-"description": "Gets a DataLabelingJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.get",
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1beta1/endpoints/{endpointsId}:generateContent",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.generateContent",
 "parameterOrder": [
-"name"
+"model"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+model}:generateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"list": {
-"description": "Lists DataLabelingJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.list",
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1beta1/endpoints/{endpointsId}:predict",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.predict",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
-"location": "query",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^endpoints/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
-"type": "string"
+"path": "v1beta1/{+endpoint}:predict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
 },
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
 },
-"parent": {
-"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1beta1/endpoints/{endpointsId}:predictLongRunning",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.predictLongRunning",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"readMask": {
-"description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1beta1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1beta1/endpoints/{endpointsId}:streamGenerateContent",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.streamGenerateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^endpoints/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/dataLabelingJobs",
+"path": "v1beta1/{+model}:streamGenerateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 }
 },
 "resources": {
+"chat": {
+"methods": {
+"completions": {
+"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
+"flatPath": "v1beta1/endpoints/{endpointsId}/chat/completions",
+"httpMethod": "POST",
+"id": "aiplatform.endpoints.chat.completions",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}/chat/completions",
+"request": {
+"$ref": "GoogleApiHttpBody"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+},
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel",
+"id": "aiplatform.endpoints.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -2723,7 +2812,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2738,9 +2827,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete",
+"id": "aiplatform.endpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -2748,7 +2837,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2763,9 +2852,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.get",
+"id": "aiplatform.endpoints.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -2773,7 +2862,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -2788,9 +2877,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations",
+"flatPath": "v1beta1/endpoints/{endpointsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.list",
+"id": "aiplatform.endpoints.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -2803,7 +2892,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
+"pattern": "^endpoints/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2834,9 +2923,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/endpoints/{endpointsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait",
+"id": "aiplatform.endpoints.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -2844,7 +2933,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
+"pattern": "^endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -2867,57 +2956,53 @@
 }
 }
 },
-"datasets": {
+"evaluationItems": {
+"resources": {
+"operations": {
 "methods": {
-"assemble": {
-"description": "Assembles each row of a multimodal dataset and writes the result into a BigQuery table.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assemble",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.assemble",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.evaluationItems.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource (used only for MULTIMODAL datasets). Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:assemble",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AssembleDataRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"assess": {
-"description": "Assesses the state or validity of the dataset with respect to a given use case.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assess",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.assess",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.evaluationItems.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource. Used only for MULTIMODAL datasets. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:assess",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AssessDataRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -2925,163 +3010,160 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.create",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.evaluationItems.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^evaluationItems/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/datasets",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.delete",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.evaluationItems.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"export": {
-"description": "Exports data from a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.export",
+"evaluationRuns": {
+"resources": {
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.evaluationRuns.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationRuns/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:export",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExportDataRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.get",
+"id": "aiplatform.evaluationRuns.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Dataset resource.",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationRuns/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"import": {
-"description": "Imports data into a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.import",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:import",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ImportDataRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Datasets in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.list",
+"id": "aiplatform.evaluationRuns.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^evaluationRuns/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -3095,228 +3177,199 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/datasets",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.datasets.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.evaluationRuns.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationRuns/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Dataset"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"searchDataItems": {
-"description": "Searches DataItems in a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.searchDataItems",
+"evaluationSets": {
+"resources": {
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.evaluationSets.operations.delete",
 "parameterOrder": [
-"dataset"
+"name"
 ],
 "parameters": {
-"annotationFilters": {
-"description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"annotationsFilter": {
-"deprecated": true,
-"description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^evaluationSets/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"annotationsLimit": {
-"description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"dataItemFilter": {
-"description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`",
-"location": "query",
-"type": "string"
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
 },
-"dataLabelingJob": {
-"description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.",
-"location": "query",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"dataset": {
-"description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.evaluationSets.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^evaluationSets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"fieldMask": {
-"description": "Mask specifying which fields of DataItemView to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"deprecated": true,
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
-"type": "string"
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
 },
-"orderByAnnotation.orderBy": {
-"description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.",
-"location": "query",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"orderByAnnotation.savedQuery": {
-"description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.evaluationSets.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderByDataItem": {
-"description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^evaluationSets/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"savedQuery": {
-"deprecated": true,
-"description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+dataset}:searchDataItems",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"annotationSpecs": {
-"methods": {
-"get": {
-"description": "Gets an AnnotationSpec.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.get",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.evaluationSets.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"pattern": "^evaluationSets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1AnnotationSpec"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"evaluationTasks": {
 "resources": {
 "operations": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete",
+"id": "aiplatform.evaluationTasks.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3324,7 +3377,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^evaluationTasks/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3339,9 +3392,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
+"flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get",
+"id": "aiplatform.evaluationTasks.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3349,7 +3402,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^evaluationTasks/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3364,9 +3417,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations",
+"flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list",
+"id": "aiplatform.evaluationTasks.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3379,7 +3432,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"pattern": "^evaluationTasks/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3410,9 +3463,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait",
+"id": "aiplatform.evaluationTasks.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3420,7 +3473,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"pattern": "^evaluationTasks/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3443,71 +3496,92 @@
 }
 }
 },
-"dataItems": {
+"exampleStores": {
+"resources": {
+"operations": {
 "methods": {
-"list": {
-"description": "Lists DataItems in a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.list",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.exampleStores.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^exampleStores/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
 },
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"parent": {
-"description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.exampleStores.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^exampleStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.exampleStores.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^exampleStores/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/dataItems",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDataItemsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"annotations": {
-"methods": {
 "list": {
-"description": "Lists Annotations belongs to a dataitem.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.list",
+"id": "aiplatform.exampleStores.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
@@ -3515,9 +3589,11 @@
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^exampleStores/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -3531,37 +3607,64 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/exampleStores/{exampleStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.exampleStores.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
+"pattern": "^exampleStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/annotations",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"extensionControllers": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel",
+"id": "aiplatform.extensionControllers.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -3569,7 +3672,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3584,9 +3687,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete",
+"id": "aiplatform.extensionControllers.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3594,7 +3697,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3609,9 +3712,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get",
+"id": "aiplatform.extensionControllers.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3619,7 +3722,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3634,9 +3737,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations",
+"flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list",
+"id": "aiplatform.extensionControllers.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3649,7 +3752,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
+"pattern": "^extensionControllers/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3680,9 +3783,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait",
+"id": "aiplatform.extensionControllers.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3690,7 +3793,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
+"pattern": "^extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3713,13 +3816,15 @@
 }
 }
 },
+"extensions": {
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel",
+"id": "aiplatform.extensions.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -3727,7 +3832,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3742,9 +3847,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.delete",
+"id": "aiplatform.extensions.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -3752,7 +3857,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3767,9 +3872,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.get",
+"id": "aiplatform.extensions.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -3777,7 +3882,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -3792,9 +3897,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations",
+"flatPath": "v1beta1/extensions/{extensionsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.list",
+"id": "aiplatform.extensions.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -3807,7 +3912,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
+"pattern": "^extensions/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3838,9 +3943,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/extensions/{extensionsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.dataItems.operations.wait",
+"id": "aiplatform.extensions.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -3848,7 +3953,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
+"pattern": "^extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -3871,196 +3976,132 @@
 }
 }
 },
-"datasetVersions": {
+"featureGroups": {
+"resources": {
+"featureMonitors": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Create a version from a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/datasetVersions",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes a Dataset version.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.delete",
+"id": "aiplatform.featureGroups.featureMonitors.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Dataset version.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.get",
+"id": "aiplatform.featureGroups.featureMonitors.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists DatasetVersions in a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.list",
+"id": "aiplatform.featureGroups.featureMonitors.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/datasetVersions",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a DatasetVersion.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.featureGroups.featureMonitors.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
+"pattern": "^featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"restore": {
-"description": "Restores a dataset version.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.datasetVersions.restore",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:restore",
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -4069,39 +4110,18 @@
 ]
 }
 }
+}
+}
 },
+"features": {
+"resources": {
 "operations": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.operations.delete",
+"id": "aiplatform.featureGroups.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -4109,7 +4129,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4124,9 +4144,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.operations.get",
+"id": "aiplatform.featureGroups.features.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -4134,7 +4154,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4149,9 +4169,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.operations.list",
+"id": "aiplatform.featureGroups.features.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -4164,7 +4184,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4195,9 +4215,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.operations.wait",
+"id": "aiplatform.featureGroups.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -4205,7 +4225,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4225,22 +4245,49 @@
 ]
 }
 }
+}
+}
 },
-"savedQueries": {
+"operations": {
 "methods": {
 "delete": {
-"description": "Deletes a SavedQuery.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.savedQueries.delete",
+"id": "aiplatform.featureGroups.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.featureGroups.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4254,12 +4301,12 @@
 ]
 },
 "list": {
-"description": "Lists SavedQueries in a Dataset.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.savedQueries.list",
+"id": "aiplatform.featureGroups.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
@@ -4267,9 +4314,11 @@
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^featureGroups/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
@@ -4283,62 +4332,66 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/savedQueries",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel",
+"id": "aiplatform.featureGroups.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
+"featureOnlineStores": {
+"resources": {
+"featureViews": {
+"resources": {
+"operations": {
+"methods": {
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -4346,7 +4399,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4361,9 +4414,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.get",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -4371,7 +4424,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4386,9 +4439,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.list",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -4401,7 +4454,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4432,9 +4485,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait",
+"id": "aiplatform.featureOnlineStores.featureViews.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -4442,7 +4495,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4464,204 +4517,153 @@
 }
 }
 }
-}
-}
 },
-"deploymentResourcePools": {
+"operations": {
 "methods": {
-"create": {
-"description": "Create a DeploymentResourcePool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploymentResourcePools.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/deploymentResourcePools",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Delete a DeploymentResourcePool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.deploymentResourcePools.delete",
+"id": "aiplatform.featureOnlineStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Get a DeploymentResourcePool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.get",
+"id": "aiplatform.featureOnlineStores.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "List DeploymentResourcePools in a location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.list",
+"id": "aiplatform.featureOnlineStores.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^featureOnlineStores/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/deploymentResourcePools",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Update a DeploymentResourcePool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.deploymentResourcePools.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.featureOnlineStores.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. The list of fields to update.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"queryDeployedModels": {
-"description": "List DeployedModels that have been deployed on this DeploymentResourcePool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels",
-"parameterOrder": [
-"deploymentResourcePool"
-],
-"parameters": {
-"deploymentResourcePool": {
-"description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
-"required": true,
-"type": "string"
-},
-"pageSize": {
-"description": "The maximum number of DeployedModels to return. The service may return fewer than this value.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1beta1/{+deploymentResourcePool}:queryDeployedModels",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+}
+}
 }
 },
+"featurestores": {
+"resources": {
+"entityTypes": {
+"resources": {
+"features": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel",
+"id": "aiplatform.featurestores.entityTypes.features.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -4669,7 +4671,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4684,9 +4686,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete",
+"id": "aiplatform.featurestores.entityTypes.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -4694,7 +4696,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4709,9 +4711,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.get",
+"id": "aiplatform.featurestores.entityTypes.features.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -4719,7 +4721,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4734,9 +4736,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.list",
+"id": "aiplatform.featurestores.entityTypes.features.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -4749,7 +4751,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4780,9 +4782,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait",
+"id": "aiplatform.featurestores.entityTypes.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -4790,7 +4792,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4813,15 +4815,13 @@
 }
 }
 },
-"edgeDevices": {
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.edgeDevices.operations.cancel",
+"id": "aiplatform.featurestores.entityTypes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -4829,7 +4829,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4844,9 +4844,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.edgeDevices.operations.delete",
+"id": "aiplatform.featurestores.entityTypes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -4854,7 +4854,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4869,9 +4869,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.edgeDevices.operations.get",
+"id": "aiplatform.featurestores.entityTypes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -4879,7 +4879,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -4894,9 +4894,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.edgeDevices.operations.list",
+"id": "aiplatform.featurestores.entityTypes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -4909,7 +4909,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4940,9 +4940,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.edgeDevices.operations.wait",
+"id": "aiplatform.featurestores.entityTypes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -4950,7 +4950,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
+"pattern": "^featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -4973,748 +4973,839 @@
 }
 }
 },
-"endpoints": {
+"operations": {
 "methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.computeTokens",
+"id": "aiplatform.featurestores.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:computeTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.countTokens",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.featurestores.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.featurestores.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates an Endpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.create",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.featurestores.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"endpointId": {
-"description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^featurestores/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/endpoints",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes an Endpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.endpoints.delete",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/featurestores/{featurestoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.featurestores.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"deployModel": {
-"description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel",
+"hyperparameterTuningJobs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.deployModel",
+"id": "aiplatform.hyperparameterTuningJobs.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:deployModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeployModelRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"directPredict": {
-"description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.directPredict",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.hyperparameterTuningJobs.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:directPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DirectPredictRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DirectPredictResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"directRawPredict": {
-"description": "Perform an unary online prediction request to a gRPC model server for custom containers.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.directRawPredict",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.hyperparameterTuningJobs.operations.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:directRawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"explain": {
-"description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.explain",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.hyperparameterTuningJobs.operations.list",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:explain",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExplainRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ExplainResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.fetchPredictOperation",
+"id": "aiplatform.hyperparameterTuningJobs.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:fetchPredictOperation",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent",
+"indexEndpoints": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.generateContent",
+"id": "aiplatform.indexEndpoints.operations.cancel",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+model}:generateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets an Endpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.get",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.indexEndpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.getIamPolicy",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.indexEndpoints.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:getIamPolicy",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Endpoints in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.list",
+"id": "aiplatform.indexEndpoints.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"gdcZone": {
-"description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^indexEndpoints/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Optional. Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/endpoints",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEndpointsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"mutateDeployedModel": {
-"description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.mutateDeployedModel",
+"id": "aiplatform.indexEndpoints.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:mutateDeployedModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"patch": {
-"description": "Updates an Endpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.endpoints.patch",
+"indexes": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.indexes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the Endpoint.",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.predict",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.indexes.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:predict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.predictLongRunning",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.indexes.operations.get",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:predictLongRunning",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"rawPredict": {
-"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.rawPredict",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/indexes/{indexesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.indexes.operations.list",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexes/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:rawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"serverStreamingPredict": {
-"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/indexes/{indexesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.serverStreamingPredict",
+"id": "aiplatform.indexes.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:serverStreamingPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy",
+"media": {
+"methods": {
+"upload": {
+"description": "Upload a file into a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:upload",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.setIamPolicy",
+"id": "aiplatform.media.upload",
+"mediaUpload": {
+"accept": [
+"*/*"
+],
+"protocols": {
+"simple": {
+"multipart": true,
+"path": "/upload/v1beta1/{+parent}/ragFiles:upload"
+}
+}
+},
 "parameterOrder": [
-"resource"
+"parent"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"parent": {
+"description": "Required. The name of the RagCorpus resource into which to upload the file. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
+"path": "v1beta1/{+parent}/ragFiles:upload",
 "request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileRequest"
 },
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1beta1UploadRagFileResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
-]
+],
+"supportsMediaUpload": true
+}
+}
 },
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent",
+"metadataStores": {
+"resources": {
+"artifacts": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.streamGenerateContent",
+"id": "aiplatform.metadataStores.artifacts.operations.cancel",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamRawPredict": {
-"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.streamRawPredict",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.metadataStores.artifacts.operations.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:streamRawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.testIamPermissions",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.metadataStores.artifacts.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"undeployModel": {
-"description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.undeployModel",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.metadataStores.artifacts.operations.list",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:undeployModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1UndeployModelRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"update": {
-"description": "Updates an Endpoint with a long running operation.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.update",
+"id": "aiplatform.metadataStores.artifacts.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the Endpoint.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+name}:update",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -5722,175 +5813,179 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"contexts": {
 "resources": {
-"chat": {
+"operations": {
 "methods": {
-"completions": {
-"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.chat.completions",
+"id": "aiplatform.metadataStores.contexts.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}/chat/completions",
-"request": {
-"$ref": "GoogleApiHttpBody"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"deployedModels": {
-"resources": {
-"invoke": {
-"methods": {
-"invoke": {
-"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.metadataStores.contexts.operations.delete",
 "parameterOrder": [
-"endpoint",
-"deployedModelId",
-"invokeId"
+"name"
 ],
 "parameters": {
-"deployedModelId": {
-"description": "ID of the DeployedModel that serves the invoke request.",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
-"required": true,
-"type": "string"
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
 },
-"invokeId": {
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.metadataStores.contexts.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1InvokeRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"invoke": {
-"methods": {
-"invoke": {
-"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.invoke.invoke",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.metadataStores.contexts.operations.list",
 "parameterOrder": [
-"endpoint",
-"invokeId"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
-"required": true,
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
 "type": "string"
 },
-"invokeId": {
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}/invoke/{+invokeId}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1InvokeRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
 },
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"openapi": {
-"methods": {
-"embeddings": {
-"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.openapi.embeddings",
+"id": "aiplatform.metadataStores.contexts.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"deployedModelId": {
-"description": "ID of the DeployedModel that serves the invoke request.",
-"location": "query",
-"type": "string"
-},
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$",
+"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}/embeddings",
-"request": {
-"$ref": "GoogleApiHttpBody"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
 },
+"executions": {
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.operations.cancel",
+"id": "aiplatform.metadataStores.executions.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -5898,7 +5993,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5913,9 +6008,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.endpoints.operations.delete",
+"id": "aiplatform.metadataStores.executions.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -5923,7 +6018,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5938,9 +6033,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.operations.get",
+"id": "aiplatform.metadataStores.executions.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -5948,7 +6043,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -5963,9 +6058,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.endpoints.operations.list",
+"id": "aiplatform.metadataStores.executions.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -5978,7 +6073,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6009,9 +6104,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.endpoints.operations.wait",
+"id": "aiplatform.metadataStores.executions.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6019,7 +6114,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6042,141 +6137,198 @@
 }
 }
 },
-"evaluationItems": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates an Evaluation Item.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationItems.create",
+"id": "aiplatform.metadataStores.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/evaluationItems",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an Evaluation Item.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationItems.delete",
+"id": "aiplatform.metadataStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets an Evaluation Item.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationItems.get",
+"id": "aiplatform.metadataStores.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Evaluation Items.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationItems.list",
+"id": "aiplatform.metadataStores.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^metadataStores/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of Evaluation Items to return.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/evaluationItems",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.metadataStores.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^metadataStores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"migratableResources": {
+"resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.migratableResources.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}",
+"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationItems.operations.delete",
+"id": "aiplatform.migratableResources.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6184,7 +6336,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6199,9 +6351,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}",
+"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationItems.operations.get",
+"id": "aiplatform.migratableResources.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6209,7 +6361,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6224,9 +6376,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations",
+"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationItems.operations.list",
+"id": "aiplatform.migratableResources.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -6239,7 +6391,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"pattern": "^migratableResources/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6270,9 +6422,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationItems.operations.wait",
+"id": "aiplatform.migratableResources.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6280,7 +6432,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$",
+"pattern": "^migratableResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6303,29 +6455,28 @@
 }
 }
 },
-"evaluationRuns": {
+"modelDeploymentMonitoringJobs": {
+"resources": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationRuns.cancel",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -6333,139 +6484,171 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates an Evaluation Run.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationRuns.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/evaluationRuns",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationRun"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationRun"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes an Evaluation Run.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationRuns.delete",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets an Evaluation Run.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationRuns.get",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationRun"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Evaluation Runs.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationRuns.list",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of Evaluation Runs to return.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/evaluationRuns",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"modelMonitors": {
 "resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.modelMonitors.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^modelMonitors/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}",
+"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationRuns.operations.delete",
+"id": "aiplatform.modelMonitors.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6473,7 +6656,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$",
+"pattern": "^modelMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6488,9 +6671,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}",
+"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationRuns.operations.get",
+"id": "aiplatform.modelMonitors.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6498,7 +6681,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$",
+"pattern": "^modelMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6513,9 +6696,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations",
+"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationRuns.operations.list",
+"id": "aiplatform.modelMonitors.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -6528,7 +6711,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"pattern": "^modelMonitors/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6559,9 +6742,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationRuns.operations.wait",
+"id": "aiplatform.modelMonitors.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6569,7 +6752,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$",
+"pattern": "^modelMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6592,175 +6775,200 @@
 }
 }
 },
-"evaluationSets": {
+"models": {
+"resources": {
+"evaluations": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates an Evaluation Set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationSets.create",
+"id": "aiplatform.models.evaluations.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/evaluationSets",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an Evaluation Set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationSets.delete",
+"id": "aiplatform.models.evaluations.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets an Evaluation Set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationSets.get",
+"id": "aiplatform.models.evaluations.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Evaluation Sets.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationSets.list",
+"id": "aiplatform.models.evaluations.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^models/[^/]+/evaluations/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of Evaluation Sets to return.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/evaluationSets",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an Evaluation Set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.evaluationSets.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.models.evaluations.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.models.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}",
+"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationSets.operations.delete",
+"id": "aiplatform.models.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6768,7 +6976,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$",
+"pattern": "^models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6783,9 +6991,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}",
+"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationSets.operations.get",
+"id": "aiplatform.models.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6793,7 +7001,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$",
+"pattern": "^models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6808,9 +7016,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations",
+"flatPath": "v1beta1/models/{modelsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationSets.operations.list",
+"id": "aiplatform.models.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -6823,7 +7031,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
+"pattern": "^models/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6854,9 +7062,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationSets.operations.wait",
+"id": "aiplatform.models.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6864,7 +7072,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$",
+"pattern": "^models/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6887,15 +7095,40 @@
 }
 }
 },
-"evaluationTasks": {
+"notebookExecutionJobs": {
 "resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.notebookExecutionJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}",
+"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.evaluationTasks.operations.delete",
+"id": "aiplatform.notebookExecutionJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -6903,7 +7136,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6918,9 +7151,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}",
+"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationTasks.operations.get",
+"id": "aiplatform.notebookExecutionJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6928,7 +7161,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6943,9 +7176,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations",
+"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.evaluationTasks.operations.list",
+"id": "aiplatform.notebookExecutionJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -6958,7 +7191,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+$",
+"pattern": "^notebookExecutionJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -6989,9 +7222,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.evaluationTasks.operations.wait",
+"id": "aiplatform.notebookExecutionJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -6999,7 +7232,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$",
+"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7022,311 +7255,175 @@
 }
 }
 },
-"exampleStores": {
+"notebookRuntimeTemplates": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Create an ExampleStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.create",
+"id": "aiplatform.notebookRuntimeTemplates.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"exampleStore.createTime": {
-"description": "Output only. Timestamp when this ExampleStore was created.",
-"format": "google-datetime",
-"location": "query",
-"type": "string"
-},
-"exampleStore.description": {
-"description": "Optional. Description of the ExampleStore.",
-"location": "query",
-"type": "string"
-},
-"exampleStore.displayName": {
-"description": "Required. Display name of the ExampleStore.",
-"location": "query",
-"type": "string"
-},
-"exampleStore.exampleStoreConfig.vertexEmbeddingModel": {
-"description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"",
-"location": "query",
-"type": "string"
-},
-"exampleStore.name": {
-"description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}",
-"location": "query",
-"type": "string"
-},
-"exampleStore.updateTime": {
-"description": "Output only. Timestamp when this ExampleStore was most recently updated.",
-"format": "google-datetime",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/exampleStores:create",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Delete an ExampleStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.exampleStores.delete",
+"id": "aiplatform.notebookRuntimeTemplates.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"fetchExamples": {
-"description": "Get Examples from the Example Store.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.fetchExamples",
-"parameterOrder": [
-"exampleStore"
-],
-"parameters": {
-"exampleStore": {
-"description": "Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+exampleStore}:fetchExamples",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchExamplesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchExamplesResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Get an ExampleStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.exampleStores.get",
+"id": "aiplatform.notebookRuntimeTemplates.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ExampleStore"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "List ExampleStores in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.exampleStores.list",
+"id": "aiplatform.notebookRuntimeTemplates.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/exampleStores",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Update an ExampleStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.exampleStores.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.notebookRuntimeTemplates.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
+"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExampleStore"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"removeExamples": {
-"description": "Remove Examples from the Example Store.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.removeExamples",
-"parameterOrder": [
-"exampleStore"
-],
-"parameters": {
-"exampleStore": {
-"description": "Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1beta1/{+exampleStore}:removeExamples",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"searchExamples": {
-"description": "Search for similar Examples for given selection criteria.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.searchExamples",
-"parameterOrder": [
-"exampleStore"
-],
-"parameters": {
-"exampleStore": {
-"description": "Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1beta1/{+exampleStore}:searchExamples",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchExamplesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"upsertExamples": {
-"description": "Create or update Examples in the Example Store.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.upsertExamples",
-"parameterOrder": [
-"exampleStore"
-],
-"parameters": {
-"exampleStore": {
-"description": "Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1beta1/{+exampleStore}:upsertExamples",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 }
 },
+"notebookRuntimes": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.operations.cancel",
+"id": "aiplatform.notebookRuntimes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -7334,7 +7431,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7349,9 +7446,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}",
+"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.exampleStores.operations.delete",
+"id": "aiplatform.notebookRuntimes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -7359,7 +7456,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7374,9 +7471,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}",
+"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.exampleStores.operations.get",
+"id": "aiplatform.notebookRuntimes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -7384,7 +7481,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7399,9 +7496,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations",
+"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.exampleStores.operations.list",
+"id": "aiplatform.notebookRuntimes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -7414,7 +7511,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
+"pattern": "^notebookRuntimes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7445,9 +7542,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.exampleStores.operations.wait",
+"id": "aiplatform.notebookRuntimes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -7455,7 +7552,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
+"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7478,15 +7575,13 @@
 }
 }
 },
-"extensionControllers": {
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensionControllers.operations.cancel",
+"id": "aiplatform.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -7494,7 +7589,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
+"pattern": "^operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7509,9 +7604,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}",
+"flatPath": "v1beta1/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.extensionControllers.operations.delete",
+"id": "aiplatform.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -7519,7 +7614,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
+"pattern": "^operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7534,9 +7629,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}",
+"flatPath": "v1beta1/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.extensionControllers.operations.get",
+"id": "aiplatform.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -7544,7 +7639,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
+"pattern": "^operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7559,12 +7654,10 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations",
+"flatPath": "v1beta1/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.extensionControllers.operations.list",
-"parameterOrder": [
-"name"
-],
+"id": "aiplatform.operations.list",
+"parameterOrder": [],
 "parameters": {
 "filter": {
 "description": "The standard list filter.",
@@ -7573,9 +7666,7 @@
 },
 "name": {
 "description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$",
-"required": true,
+"location": "query",
 "type": "string"
 },
 "pageSize": {
@@ -7595,7 +7686,7 @@
 "type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/operations",
 "response": {
 "$ref": "GoogleLongrunningListOperationsResponse"
 },
@@ -7605,9 +7696,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensionControllers.operations.wait",
+"id": "aiplatform.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -7615,7 +7706,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
+"pattern": "^operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7635,111 +7726,80 @@
 ]
 }
 }
-}
-}
 },
-"extensions": {
+"persistentResources": {
+"resources": {
+"operations": {
 "methods": {
-"delete": {
-"description": "Deletes an Extension.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.extensions.delete",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.persistentResources.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"execute": {
-"description": "Executes the request against a given extension.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensions.execute",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.persistentResources.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:execute",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets an Extension.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.extensions.get",
+"id": "aiplatform.persistentResources.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Extension"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"import": {
-"description": "Imports an Extension.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensions.import",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/extensions:import",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Extension"
-},
-"response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
@@ -7747,123 +7807,95 @@
 ]
 },
 "list": {
-"description": "Lists Extensions in a location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.extensions.list",
+"id": "aiplatform.persistentResources.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^persistentResources/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/extensions",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an Extension.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.extensions.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.persistentResources.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the Extension.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
+"pattern": "^persistentResources/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Extension"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Extension"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"query": {
-"description": "Queries an extension with a default controller.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensions.query",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1beta1/{+name}:query",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+}
+}
 }
 },
+"pipelineJobs": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensions.operations.cancel",
+"id": "aiplatform.pipelineJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -7871,7 +7903,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7886,9 +7918,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}",
+"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.extensions.operations.delete",
+"id": "aiplatform.pipelineJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -7896,7 +7928,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7911,9 +7943,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}",
+"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.extensions.operations.get",
+"id": "aiplatform.pipelineJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -7921,7 +7953,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -7936,9 +7968,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations",
+"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.extensions.operations.list",
+"id": "aiplatform.pipelineJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -7951,7 +7983,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
+"pattern": "^pipelineJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -7982,9 +8014,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.extensions.operations.wait",
+"id": "aiplatform.pipelineJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -7992,7 +8024,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
+"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8015,199 +8047,194 @@
 }
 }
 },
-"featureGroups": {
+"projects": {
 "methods": {
-"create": {
-"description": "Creates a new FeatureGroup in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.create",
+"fetchPublisherModelConfig": {
+"description": "Fetches the configs of publisher models.",
+"flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig",
+"httpMethod": "GET",
+"id": "aiplatform.projects.fetchPublisherModelConfig",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"featureGroupId": {
-"description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureGroups",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureGroup"
-},
+"path": "v1beta1/{+name}:fetchPublisherModelConfig",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a single FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.delete",
+"getCacheConfig": {
+"description": "Gets a GenAI cache config.",
+"flatPath": "v1beta1/projects/{projectsId}/cacheConfig",
+"httpMethod": "GET",
+"id": "aiplatform.projects.getCacheConfig",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/cacheConfig$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1CacheConfig"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.get",
+"setPublisherModelConfig": {
+"description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.",
+"flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig",
+"httpMethod": "POST",
+"id": "aiplatform.projects.setPublisherModelConfig",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureGroup resource.",
+"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:setPublisherModelConfig",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureGroup"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.getIamPolicy",
+"updateCacheConfig": {
+"description": "Updates a cache config.",
+"flatPath": "v1beta1/projects/{projectsId}/cacheConfig",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.updateCacheConfig",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/cacheConfig$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:getIamPolicy",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CacheConfig"
+},
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"list": {
-"description": "Lists FeatureGroups in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.list",
+"resources": {
+"locations": {
+"methods": {
+"augmentPrompt": {
+"description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.augmentPrompt",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".",
-"location": "query",
+"parent": {
+"description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
-"location": "query",
-"type": "string"
+"path": "v1beta1/{+parent}:augmentPrompt",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest"
 },
-"pageSize": {
-"description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse"
 },
-"pageToken": {
-"description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.",
-"location": "query",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
+"corroborateContent": {
+"description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.corroborateContent",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureGroups",
+"path": "v1beta1/{+parent}:corroborateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the parameters of a single FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureGroups.patch",
+"deploy": {
+"description": "Deploys a model to a new endpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.deploy",
 "parameterOrder": [
-"name"
+"destination"
 ],
 "parameters": {
-"name": {
-"description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
+"destination": {
+"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+destination}:deploy",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureGroup"
+"$ref": "GoogleCloudAiplatformV1beta1DeployRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -8216,350 +8243,364 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy",
+"deployPublisherModel": {
+"deprecated": true,
+"description": "Deploys publisher models.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.setIamPolicy",
+"id": "aiplatform.projects.locations.deployPublisherModel",
 "parameterOrder": [
-"resource"
+"destination"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"destination": {
+"description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
+"path": "v1beta1/{+destination}:deployPublisherModel",
 "request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest"
 },
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions",
+"evaluateDataset": {
+"description": "Evaluates a dataset based on a set of given metrics.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.testIamPermissions",
+"id": "aiplatform.projects.locations.evaluateDataset",
 "parameterOrder": [
-"resource"
+"location"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
+"location": {
+"description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"path": "v1beta1/{+location}:evaluateDataset",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"evaluateInstances": {
+"description": "Evaluates instances based on a given metric.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluateInstances",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
+"path": "v1beta1/{+location}:evaluateInstances",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest"
+},
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"featureMonitors": {
-"methods": {
-"create": {
-"description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors",
+"generateInstanceRubrics": {
+"description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.create",
+"id": "aiplatform.projects.locations.generateInstanceRubrics",
 "parameterOrder": [
-"parent"
+"location"
 ],
 "parameters": {
-"featureMonitorId": {
-"description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.",
-"location": "query",
+"location": {
+"description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"parent": {
-"description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`",
+"path": "v1beta1/{+location}:generateInstanceRubrics",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generateSyntheticData": {
+"description": "Generates synthetic data based on the provided configuration.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.generateSyntheticData",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureMonitors",
+"path": "v1beta1/{+location}:generateSyntheticData",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a single FeatureMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete",
+"get": {
+"description": "Gets information about a location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`",
+"description": "Resource name for the location.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudLocationLocation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single FeatureMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}",
+"getRagEngineConfig": {
+"description": "Gets a RagEngineConfig.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.get",
+"id": "aiplatform.projects.locations.getRagEngineConfig",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureMonitor resource.",
+"description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor"
+"$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists FeatureGroups in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors",
+"description": "Lists information about the supported locations for this service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.list",
+"id": "aiplatform.projects.locations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".",
+"extraLocationTypes": {
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
+"repeated": true,
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
+"filter": {
+"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The resource that owns the locations collection, if applicable.",
+"location": "path",
+"pattern": "^projects/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"description": "The maximum number of results to return. If not set, the service selects a default.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.",
+"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
 "location": "query",
 "type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
-"required": true,
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureMonitors",
+"path": "v1beta1/{+name}/locations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse"
+"$ref": "GoogleCloudLocationListLocationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the parameters of a single FeatureMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch",
+"recommendSpec": {
+"description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.recommendSpec",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`",
+"parent": {
+"description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}:recommendSpec",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor"
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"featureMonitorJobs": {
-"methods": {
-"create": {
-"description": "Creates a new feature monitor job.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs",
+"retrieveContexts": {
+"description": "Retrieves relevant contexts for a query.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create",
+"id": "aiplatform.projects.locations.retrieveContexts",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"featureMonitorJobId": {
-"description": "Optional. Output only. System-generated ID for feature monitor job.",
-"format": "int64",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`",
+"description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureMonitorJobs",
+"path": "v1beta1/{+parent}:retrieveContexts",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob"
+"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob"
+"$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Get a feature monitor job.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get",
+"updateRagEngineConfig": {
+"description": "Updates a RagEngineConfig.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.updateRagEngineConfig",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`",
+"description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"list": {
-"description": "List feature monitor jobs.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list",
+"resources": {
+"agents": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.agents.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time`",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureMonitorJobs",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"operations": {
-"methods": {
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete",
+"id": "aiplatform.projects.locations.agents.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -8567,7 +8608,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8582,9 +8623,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get",
+"id": "aiplatform.projects.locations.agents.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -8592,7 +8633,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -8607,9 +8648,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list",
+"id": "aiplatform.projects.locations.agents.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -8622,7 +8663,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8653,9 +8694,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait",
+"id": "aiplatform.projects.locations.agents.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -8663,7 +8704,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -8686,304 +8727,288 @@
 }
 }
 },
-"features": {
+"apps": {
+"resources": {
+"operations": {
 "methods": {
-"batchCreate": {
-"description": "Creates a batch of Features in a given FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.features.batchCreate",
+"id": "aiplatform.projects.locations.apps.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/features:batchCreate",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a new Feature in a given FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.features.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"featureId": {
-"description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/features",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a single Feature.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.features.delete",
+"id": "aiplatform.projects.locations.apps.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets details of a single Feature.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.get",
+"id": "aiplatform.projects.locations.apps.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"featureStatsAndAnomalySpec.latestStatsCount": {
-"description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"featureStatsAndAnomalySpec.statsTimeRange.endTime": {
-"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
-"format": "google-datetime",
-"location": "query",
-"type": "string"
-},
-"featureStatsAndAnomalySpec.statsTimeRange.startTime": {
-"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
-"format": "google-datetime",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Features in a given FeatureGroup.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.list",
+"id": "aiplatform.projects.locations.apps.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"latestStatsCount": {
-"description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.apps.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/features",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"patch": {
-"description": "Updates the parameters of a single Feature.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureGroups.features.patch",
+"batchPredictionJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.batchPredictionJobs.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
+"description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)",
-"format": "google-fieldmask",
-"location": "query",
+"path": "v1beta1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.batchPredictionJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/batchPredictionJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
+"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
+"description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.delete",
+"id": "aiplatform.projects.locations.batchPredictionJobs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
+"description": "Gets a BatchPredictionJob",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.get",
+"id": "aiplatform.projects.locations.batchPredictionJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations",
+"description": "Lists BatchPredictionJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.list",
+"id": "aiplatform.projects.locations.batchPredictionJobs.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
-"required": true,
-"type": "string"
-},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -8991,74 +9016,77 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"parent": {
+"description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/batchPredictionJobs",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
+"cachedContents": {
+"methods": {
+"create": {
+"description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.features.operations.wait",
+"id": "aiplatform.projects.locations.cachedContents.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"parent": {
+"description": "Required. The parent resource where the cached content will be created",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+parent}/cachedContents",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"operations": {
-"methods": {
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"description": "Deletes cached content",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureGroups.operations.delete",
+"id": "aiplatform.projects.locations.cachedContents.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The resource name referring to the cached content",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -9072,924 +9100,929 @@
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"description": "Gets cached content configurations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.operations.get",
+"id": "aiplatform.projects.locations.cachedContents.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The resource name referring to the cached content",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations",
+"description": "Lists cached contents in a project",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureGroups.operations.list",
+"id": "aiplatform.projects.locations.cachedContents.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
-"required": true,
-"type": "string"
-},
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The parent, which owns this collection of cached contents.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/cachedContents",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListCachedContentsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureGroups.operations.wait",
+"patch": {
+"description": "Updates cached content configurations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents/{cachedContentsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.cachedContents.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/cachedContents/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. The list of fields to update.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1CachedContent"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
-}
-}
 },
-"featureOnlineStores": {
+"customJobs": {
 "methods": {
-"create": {
-"description": "Creates a new FeatureOnlineStore in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"cancel": {
+"description": "Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.create",
+"id": "aiplatform.projects.locations.customJobs.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"featureOnlineStoreId": {
-"description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. The name of the CustomJob to cancel. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureOnlineStores",
+"path": "v1beta1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore"
+"$ref": "GoogleCloudAiplatformV1beta1CancelCustomJobRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.delete",
+"create": {
+"description": "Creates a CustomJob. A created CustomJob right away will be attempted to be run.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)",
-"location": "query",
-"type": "boolean"
-},
-"name": {
-"description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"parent": {
+"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/customJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CustomJob"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1CustomJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single FeatureOnlineStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.get",
+"delete": {
+"description": "Deletes a CustomJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.customJobs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureOnlineStore resource.",
+"description": "Required. The name of the CustomJob resource to be deleted. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy",
+"get": {
+"description": "Gets a CustomJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the CustomJob resource. Format: `projects/{project}/locations/{location}/customJobs/{custom_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:getIamPolicy",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1beta1CustomJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists FeatureOnlineStores in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"description": "Lists CustomJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.list",
+"id": "aiplatform.projects.locations.customJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.",
+"description": "The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureOnlineStores",
+"path": "v1beta1/{+parent}/customJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListCustomJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"patch": {
-"description": "Updates the parameters of a single FeatureOnlineStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureOnlineStores.patch",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.customJobs.operations.delete",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"featureViews": {
-"methods": {
-"create": {
-"description": "Creates a new FeatureView in a given FeatureOnlineStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.customJobs.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"featureViewId": {
-"description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.",
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
-"runSyncImmediately": {
-"description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.",
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
 "type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/featureViews",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureView"
-},
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a single FeatureView.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/customJobs/{customJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.customJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/customJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"directWrite": {
-"description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite",
+"dataLabelingJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a DataLabelingJob. Success of cancellation is not guaranteed.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite",
+"id": "aiplatform.projects.locations.dataLabelingJobs.cancel",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"name": {
+"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+featureView}:directWrite",
+"path": "v1beta1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest"
+"$ref": "GoogleCloudAiplatformV1beta1CancelDataLabelingJobRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchFeatureValues": {
-"description": "Fetch feature values under a FeatureView.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues",
+"create": {
+"description": "Creates a DataLabelingJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues",
+"id": "aiplatform.projects.locations.dataLabelingJobs.create",
 "parameterOrder": [
-"featureView"
+"parent"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"parent": {
+"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+featureView}:fetchFeatureValues",
+"path": "v1beta1/{+parent}/dataLabelingJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateFetchAccessToken": {
-"description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken",
+"delete": {
+"description": "Deletes a DataLabelingJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.dataLabelingJobs.delete",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"name": {
+"description": "Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+featureView}:generateFetchAccessToken",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets details of a single FeatureView.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"description": "Gets a DataLabelingJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get",
+"id": "aiplatform.projects.locations.dataLabelingJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "Required. The name of the DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureView"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1beta1DataLabelingJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists FeatureViews in a given FeatureOnlineStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
+"description": "Lists DataLabelingJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list",
+"id": "aiplatform.projects.locations.dataLabelingJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`",
+"description": "A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"description": "Required. The parent of the DataLabelingJob. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: \"name\"`. The \"name\" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureViews",
+"path": "v1beta1/{+parent}/dataLabelingJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListDataLabelingJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"patch": {
-"description": "Updates the parameters of a single FeatureView.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureView"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"searchNearestEntities": {
-"description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.delete",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+featureView}:searchNearestEntities",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamingFetchFeatureValues": {
-"description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.list",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+featureView}:streamingFetchFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"sync": {
-"description": "Triggers on-demand sync for the FeatureView.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dataLabelingJobs/{dataLabelingJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync",
+"id": "aiplatform.projects.locations.dataLabelingJobs.operations.wait",
 "parameterOrder": [
-"featureView"
+"name"
 ],
 "parameters": {
-"featureView": {
-"description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/dataLabelingJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+featureView}:sync",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions",
+"datasets": {
+"methods": {
+"assemble": {
+"description": "Assembles each row of a multimodal dataset and writes the result into a BigQuery table.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assemble",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions",
+"id": "aiplatform.projects.locations.datasets.assemble",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the Dataset resource (used only for MULTIMODAL datasets). Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
+"path": "v1beta1/{+name}:assemble",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AssembleDataRequest"
+},
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"featureViewSyncs": {
-"methods": {
-"get": {
-"description": "Gets details of a single FeatureViewSync.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get",
+"assess": {
+"description": "Assesses the state or validity of the dataset with respect to a given use case.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:assess",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.assess",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`",
+"description": "Required. The name of the Dataset resource. Used only for MULTIMODAL datasets. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:assess",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AssessDataRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists FeatureViewSyncs in a given FeatureView.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list",
+"create": {
+"description": "Creates a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.",
-"location": "query",
+"parent": {
+"description": "Required. The resource name of the Location to create the Dataset in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`",
-"location": "query",
-"type": "string"
+"path": "v1beta1/{+parent}/datasets",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
 },
-"pageSize": {
-"description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
-"format": "int32",
-"location": "query",
-"type": "integer"
+"response": {
+"$ref": "GoogleLongrunningOperation"
 },
-"pageToken": {
-"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.",
-"location": "query",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"parent": {
-"description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"delete": {
+"description": "Deletes a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Dataset to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/featureViewSyncs",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"operations": {
-"methods": {
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete",
+"export": {
+"description": "Exports data from a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:export",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.export",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:export",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExportDataRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
+"description": "Gets a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get",
+"id": "aiplatform.projects.locations.datasets.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the Dataset resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Imports data into a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.import",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ImportDataRequest"
+},
+"response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
@@ -9997,24 +10030,22 @@
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations",
+"description": "Lists Datasets in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list",
+"id": "aiplatform.projects.locations.datasets.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time`",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
@@ -10028,62 +10059,228 @@
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"parent": {
+"description": "Required. The name of the Dataset's parent resource. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/datasets",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListDatasetsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait",
+"patch": {
+"description": "Updates a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.datasets.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Output only. Identifier. The resource name of the Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels`",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Dataset"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"searchDataItems": {
+"description": "Searches DataItems in a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}:searchDataItems",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.searchDataItems",
+"parameterOrder": [
+"dataset"
+],
+"parameters": {
+"annotationFilters": {
+"description": "An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"annotationsFilter": {
+"deprecated": true,
+"description": "An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=.",
+"location": "query",
+"type": "string"
+},
+"annotationsLimit": {
+"description": "If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"dataItemFilter": {
+"description": "An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)`",
+"location": "query",
+"type": "string"
+},
+"dataLabelingJob": {
+"description": "The resource name of a DataLabelingJob. Format: `projects/{project}/locations/{location}/dataLabelingJobs/{data_labeling_job}` If this field is set, all of the search will be done in the context of this DataLabelingJob.",
+"location": "query",
+"type": "string"
+},
+"dataset": {
+"description": "Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"fieldMask": {
+"description": "Mask specifying which fields of DataItemView to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"deprecated": true,
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"orderByAnnotation.orderBy": {
+"description": "A comma-separated list of annotation fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Must also specify saved_query.",
+"location": "query",
+"type": "string"
+},
+"orderByAnnotation.savedQuery": {
+"description": "Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering.",
+"location": "query",
+"type": "string"
+},
+"orderByDataItem": {
+"description": "A comma-separated list of data item fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Requested page size. Server may return fewer results than requested. Default and maximum page size is 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call.",
+"location": "query",
+"type": "string"
+},
+"savedQuery": {
+"deprecated": true,
+"description": "The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}` All of the search will be done in the context of this SavedQuery.",
+"location": "query",
+"type": "string"
 }
+},
+"path": "v1beta1/{+dataset}:searchDataItems",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchDataItemsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
+},
+"resources": {
+"annotationSpecs": {
+"methods": {
+"get": {
+"description": "Gets an AnnotationSpec.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the AnnotationSpec resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/annotationSpecs/{annotation_spec}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1AnnotationSpec"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
+"resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.delete",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -10091,7 +10288,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -10106,9 +10303,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.get",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -10116,7 +10313,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -10131,9 +10328,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.list",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -10146,7 +10343,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -10177,9 +10374,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/annotationSpecs/{annotationSpecsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featureOnlineStores.operations.wait",
+"id": "aiplatform.projects.locations.datasets.annotationSpecs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -10187,7 +10384,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/annotationSpecs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -10210,450 +10407,456 @@
 }
 }
 },
-"featurestores": {
+"dataItems": {
 "methods": {
-"batchReadFeatureValues": {
-"description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues",
+"list": {
+"description": "Lists DataItems in a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.list",
 "parameterOrder": [
-"featurestore"
+"parent"
 ],
 "parameters": {
-"featurestore": {
-"description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+featurestore}:batchReadFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest"
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+parent}/dataItems",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ListDataItemsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"create": {
-"description": "Creates a new Featurestore in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.create",
+"resources": {
+"annotations": {
+"methods": {
+"list": {
+"description": "Lists Annotations belongs to a dataitem.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"featurestoreId": {
-"description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project}/locations/{location}/datasets/{dataset}/dataItems/{data_item}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/featurestores",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Featurestore"
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+parent}/annotations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"delete": {
-"description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.delete",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single Featurestore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.get",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Featurestore resource.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Featurestore"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.getIamPolicy",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:getIamPolicy",
-"request": {
-"$ref": "GoogleIamV1GetIamPolicyRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Featurestores in a given project and location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.list",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/featurestores",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the parameters of a single Featurestore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featurestores.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations/{annotationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/annotations/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Featurestore"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"searchFeatures": {
-"description": "Searches Features matching a query in a given project.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.searchFeatures",
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.cancel",
 "parameterOrder": [
-"location"
+"name"
 ],
 "parameters": {
-"location": {
-"description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.",
-"location": "query",
-"type": "string"
-},
-"query": {
-"description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+location}/featurestores:searchFeatures",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.setIamPolicy",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.delete",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.testIamPermissions",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
-"request": {
-"$ref": "GoogleIamV1TestIamPermissionsRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"entityTypes": {
-"methods": {
-"create": {
-"description": "Creates a new EntityType in a given Featurestore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.create",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"entityTypeId": {
-"description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.",
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/entityTypes",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EntityType"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
 },
-"delete": {
-"description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"force": {
-"description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
 "type": "boolean"
-},
-"name": {
-"description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
-"required": true,
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deleteFeatureValues": {
-"description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues",
+"id": "aiplatform.projects.locations.datasets.dataItems.operations.wait",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dataItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+entityType}:deleteFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"exportFeatureValues": {
-"description": "Exports Feature values from all the entities of a target EntityType.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues",
+"datasetVersions": {
+"methods": {
+"create": {
+"description": "Create a version from a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.create",
 "parameterOrder": [
-"entityType"
+"parent"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
+"parent": {
+"description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+entityType}:exportFeatureValues",
+"path": "v1beta1/{+parent}/datasetVersions",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -10662,160 +10865,132 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets details of a single EntityType.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.get",
+"delete": {
+"description": "Deletes a Dataset version.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EntityType"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy",
+"get": {
+"description": "Gets a Dataset version.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "GoogleIamV1Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 },
-"importFeatureValues": {
-"description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues",
-"parameterOrder": [
-"entityType"
-],
-"parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
-"required": true,
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+entityType}:importFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists EntityTypes in a given Featurestore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
+"description": "Lists DatasetVersions in a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.list",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.",
+"description": "Optional. The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`",
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
+"description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 },
 "readMask": {
-"description": "Mask specifying which fields to read.",
+"description": "Optional. Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/entityTypes",
+"path": "v1beta1/{+parent}/datasetVersions",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates the parameters of a single EntityType.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
+"description": "Updates a DatasetVersion.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.patch",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.",
+"description": "Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`",
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -10823,331 +10998,259 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1EntityType"
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EntityType"
+"$ref": "GoogleCloudAiplatformV1beta1DatasetVersion"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"readFeatureValues": {
-"description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues",
+"restore": {
+"description": "Restores a dataset version.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.datasetVersions.restore",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"name": {
+"description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+entityType}:readFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest"
-},
+"path": "v1beta1/{+name}:restore",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy",
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy",
+"id": "aiplatform.projects.locations.datasets.operations.cancel",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamingReadFeatureValues": {
-"description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.operations.delete",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+entityType}:streamingReadFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.operations.get",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"writeFeatureValues": {
-"description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.datasets.operations.list",
 "parameterOrder": [
-"entityType"
+"name"
 ],
 "parameters": {
-"entityType": {
-"description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
-"required": true,
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
 "type": "string"
-}
-},
-"path": "v1beta1/{+entityType}:writeFeatureValues",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
 },
-"resources": {
-"features": {
-"methods": {
-"batchCreate": {
-"description": "Creates a batch of Features in a given EntityType.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+parent}/features:batchCreate",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"create": {
-"description": "Creates a new Feature in a given EntityType.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"featureId": {
-"description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.",
+"pageToken": {
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/features",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
-},
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a single Feature.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.datasets.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"get": {
-"description": "Gets details of a single Feature.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.get",
+"savedQueries": {
+"methods": {
+"delete": {
+"description": "Deletes a SavedQuery.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.datasets.savedQueries.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"featureStatsAndAnomalySpec.latestStatsCount": {
-"description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"featureStatsAndAnomalySpec.statsTimeRange.endTime": {
-"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
-"format": "google-datetime",
-"location": "query",
-"type": "string"
-},
-"featureStatsAndAnomalySpec.statsTimeRange.startTime": {
-"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
-"format": "google-datetime",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "Required. The resource name of the SavedQuery to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/savedQueries/{saved_query}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Features in a given EntityType.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
+"description": "Lists SavedQueries in a Dataset.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.list",
+"id": "aiplatform.projects.locations.datasets.savedQueries.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"latestStatsCount": {
-"description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
+"description": "Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11158,43 +11261,9 @@
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/features",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates the parameters of a single Feature.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
-},
+"path": "v1beta1/{+parent}/savedQueries",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Feature"
+"$ref": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -11206,9 +11275,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -11216,7 +11285,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11231,9 +11300,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -11241,7 +11310,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11256,9 +11325,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -11266,7 +11335,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11281,9 +11350,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -11296,7 +11365,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11327,9 +11396,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/savedQueries/{savedQueriesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait",
+"id": "aiplatform.projects.locations.datasets.savedQueries.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -11337,7 +11406,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/savedQueries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11359,172 +11428,204 @@
 }
 }
 }
+}
+}
 },
-"operations": {
+"deploymentResourcePools": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
+"create": {
+"description": "Create a DeploymentResourcePool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel",
+"id": "aiplatform.projects.locations.deploymentResourcePools.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"parent": {
+"description": "Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+parent}/deploymentResourcePools",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CreateDeploymentResourcePoolRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
+"description": "Delete a DeploymentResourcePool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete",
+"id": "aiplatform.projects.locations.deploymentResourcePools.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
+"description": "Get a DeploymentResourcePool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get",
+"id": "aiplatform.projects.locations.deploymentResourcePools.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations",
+"description": "List DeploymentResourcePools in a location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list",
+"id": "aiplatform.projects.locations.deploymentResourcePools.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
-"required": true,
-"type": "string"
-},
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of DeploymentResourcePools to return. The service may return fewer than this value.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/deploymentResourcePools",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListDeploymentResourcePoolsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait",
+"patch": {
+"description": "Update a DeploymentResourcePool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.deploymentResourcePools.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. The list of fields to update.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"queryDeployedModels": {
+"description": "List DeployedModels that have been deployed on this DeploymentResourcePool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels",
+"parameterOrder": [
+"deploymentResourcePool"
+],
+"parameters": {
+"deploymentResourcePool": {
+"description": "Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of DeployedModels to return. The service may return fewer than this value.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
 }
-}
-}
+},
+"path": "v1beta1/{+deploymentResourcePool}:queryDeployedModels",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1QueryDeployedModelsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.operations.cancel",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -11532,7 +11633,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11547,9 +11648,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.featurestores.operations.delete",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -11557,7 +11658,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11572,9 +11673,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.operations.get",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -11582,7 +11683,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -11597,9 +11698,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.featurestores.operations.list",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -11612,7 +11713,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11643,9 +11744,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.featurestores.operations.wait",
+"id": "aiplatform.projects.locations.deploymentResourcePools.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -11653,7 +11754,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -11676,29 +11777,28 @@
 }
 }
 },
-"hyperparameterTuningJobs": {
+"edgeDevices": {
+"resources": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel",
+"id": "aiplatform.projects.locations.edgeDevices.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -11706,98 +11806,77 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a HyperparameterTuningJob",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.create",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.edgeDevices.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/hyperparameterTuningJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a HyperparameterTuningJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a HyperparameterTuningJob",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.get",
+"id": "aiplatform.projects.locations.edgeDevices.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists HyperparameterTuningJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.list",
+"id": "aiplatform.projects.locations.edgeDevices.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -11805,104 +11884,144 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/edgeDevices/{edgeDevicesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.edgeDevices.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/edgeDevices/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/hyperparameterTuningJobs",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"operations": {
+"endpoints": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:computeTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel",
+"id": "aiplatform.projects.locations.endpoints.computeTokens",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+endpoint}:computeTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete",
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:countTokens",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.countTokens",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:countTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get",
+"create": {
+"description": "Creates an Endpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"endpointId": {
+"description": "Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/endpoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -11910,234 +12029,276 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list",
+"delete": {
+"description": "Deletes an Endpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.endpoints.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "The name of the operation's parent resource.",
+"description": "Required. The name of the Endpoint resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait",
+"deployModel": {
+"description": "Deploys a Model into this Endpoint, creating a DeployedModel within it.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:deployModel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait",
+"id": "aiplatform.projects.locations.endpoints.deployModel",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"endpoint": {
+"description": "Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+endpoint}:deployModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1DeployModelRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
+},
+"directPredict": {
+"description": "Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.directPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"indexEndpoints": {
-"methods": {
-"create": {
-"description": "Creates an IndexEndpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
+"path": "v1beta1/{+endpoint}:directPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1DirectPredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1DirectPredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"directRawPredict": {
+"description": "Perform an unary online prediction request to a gRPC model server for custom containers.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:directRawPredict",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.create",
+"id": "aiplatform.projects.locations.endpoints.directRawPredict",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/indexEndpoints",
+"path": "v1beta1/{+endpoint}:directRawPredict",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1DirectRawPredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"delete": {
-"description": "Deletes an IndexEndpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexEndpoints.delete",
+"explain": {
+"description": "Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:explain",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.explain",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:explain",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExplainRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ExplainResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"deployIndex": {
-"description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex",
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:fetchPredictOperation",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.deployIndex",
+"id": "aiplatform.projects.locations.endpoints.fetchPredictOperation",
 "parameterOrder": [
-"indexEndpoint"
+"endpoint"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+indexEndpoint}:deployIndex",
+"path": "v1beta1/{+endpoint}:fetchPredictOperation",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest"
+"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"findNeighbors": {
-"description": "Finds the nearest neighbors of each vector within the request.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors",
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:generateContent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.findNeighbors",
+"id": "aiplatform.projects.locations.endpoints.generateContent",
 "parameterOrder": [
-"indexEndpoint"
+"model"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+indexEndpoint}:findNeighbors",
+"path": "v1beta1/{+model}:generateContent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "get": {
-"description": "Gets an IndexEndpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"description": "Gets an Endpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.get",
+"id": "aiplatform.projects.locations.endpoints.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"description": "Required. The name of the Endpoint resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists IndexEndpoints in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
+"description": "Lists Endpoints in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.list",
+"id": "aiplatform.projects.locations.endpoints.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`",
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"location": "query",
+"type": "string"
+},
+"gdcZone": {
+"description": "Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment.",
 "location": "query",
 "type": "string"
 },
@@ -12148,12 +12309,12 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.",
+"description": "Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -12166,34 +12327,34 @@
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/indexEndpoints",
+"path": "v1beta1/{+parent}/endpoints",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListEndpointsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"mutateDeployedIndex": {
-"description": "Update an existing DeployedIndex under an IndexEndpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex",
+"mutateDeployedModel": {
+"description": "Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only).",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:mutateDeployedModel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex",
+"id": "aiplatform.projects.locations.endpoints.mutateDeployedModel",
 "parameterOrder": [
-"indexEndpoint"
+"endpoint"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex",
+"path": "v1beta1/{+endpoint}:mutateDeployedModel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1DeployedIndex"
+"$ref": "GoogleCloudAiplatformV1beta1MutateDeployedModelRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -12203,18 +12364,18 @@
 ]
 },
 "patch": {
-"description": "Updates an IndexEndpoint.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"description": "Updates an Endpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.indexEndpoints.patch",
+"id": "aiplatform.projects.locations.endpoints.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the IndexEndpoint.",
+"description": "Output only. The resource name of the Endpoint.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -12227,279 +12388,269 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
+"$ref": "GoogleCloudAiplatformV1beta1Endpoint"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"readIndexDatapoints": {
-"description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints",
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predict",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints",
+"id": "aiplatform.projects.locations.endpoints.predict",
 "parameterOrder": [
-"indexEndpoint"
+"endpoint"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+indexEndpoint}:readIndexDatapoints",
+"path": "v1beta1/{+endpoint}:predict",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"undeployIndex": {
-"description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex",
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:predictLongRunning",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.undeployIndex",
+"id": "aiplatform.projects.locations.endpoints.predictLongRunning",
 "parameterOrder": [
-"indexEndpoint"
+"endpoint"
 ],
 "parameters": {
-"indexEndpoint": {
-"description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+indexEndpoint}:undeployIndex",
+"path": "v1beta1/{+endpoint}:predictLongRunning",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest"
+"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel",
+"rawPredict": {
+"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:rawPredict",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.cancel",
+"id": "aiplatform.projects.locations.endpoints.rawPredict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+endpoint}:rawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.delete",
+"serverStreamingPredict": {
+"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:serverStreamingPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.serverStreamingPredict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:serverStreamingPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.get",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.setIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.list",
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamGenerateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.streamGenerateContent",
 "parameterOrder": [
-"name"
+"model"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+model}:streamGenerateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait",
+"streamRawPredict": {
+"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:streamRawPredict",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexEndpoints.operations.wait",
+"id": "aiplatform.projects.locations.endpoints.streamRawPredict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+endpoint}:streamRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
-}
-}
-}
-}
 },
-"indexes": {
-"methods": {
-"create": {
-"description": "Creates an Index.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:testIamPermissions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.create",
+"id": "aiplatform.projects.locations.endpoints.testIamPermissions",
 "parameterOrder": [
-"parent"
+"resource"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`",
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/indexes",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Index"
-},
+"path": "v1beta1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexes.delete",
+"undeployModel": {
+"description": "Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:undeployModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.undeployModel",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:undeployModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UndeployModelRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -12507,205 +12658,203 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets an Index.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.get",
+"update": {
+"description": "Updates an Endpoint with a long running operation.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}:update",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.update",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"description": "Output only. The resource name of the Endpoint.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:update",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UpdateEndpointLongRunningRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Index"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"import": {
-"description": "Imports an Index from an external source (e.g., BigQuery).",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import",
+"resources": {
+"chat": {
+"methods": {
+"completions": {
+"description": "Exposes an OpenAI-compatible endpoint for chat completions.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/chat/completions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.import",
+"id": "aiplatform.projects.locations.endpoints.chat.completions",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"endpoint": {
+"description": "Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:import",
+"path": "v1beta1/{+endpoint}/chat/completions",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest"
+"$ref": "GoogleApiHttpBody"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
+}
+}
 },
-"list": {
-"description": "Lists Indexes in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.list",
+"deployedModels": {
+"resources": {
+"invoke": {
+"methods": {
+"invoke": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke",
 "parameterOrder": [
-"parent"
+"endpoint",
+"deployedModelId",
+"invokeId"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`",
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/indexes",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates an Index.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.indexes.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Output only. The resource name of the Index.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
-"format": "google-fieldmask",
-"location": "query",
+"invokeId": {
+"location": "path",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Index"
+"$ref": "GoogleCloudAiplatformV1beta1InvokeRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
+}
+}
+}
+}
 },
-"removeDatapoints": {
-"description": "Remove Datapoints from an Index.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints",
+"invoke": {
+"methods": {
+"invoke": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.removeDatapoints",
+"id": "aiplatform.projects.locations.endpoints.invoke.invoke",
 "parameterOrder": [
-"index"
+"endpoint",
+"invokeId"
 ],
 "parameters": {
-"index": {
-"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
+"required": true,
+"type": "string"
+},
+"invokeId": {
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+index}:removeDatapoints",
+"path": "v1beta1/{+endpoint}/invoke/{+invokeId}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1InvokeRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
+}
+}
 },
-"upsertDatapoints": {
-"description": "Add/update Datapoints into an Index.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints",
+"openapi": {
+"methods": {
+"embeddings": {
+"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.upsertDatapoints",
+"id": "aiplatform.projects.locations.endpoints.openapi.embeddings",
 "parameterOrder": [
-"index"
+"endpoint"
 ],
 "parameters": {
-"index": {
-"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"deployedModelId": {
+"description": "ID of the DeployedModel that serves the invoke request.",
+"location": "query",
+"type": "string"
+},
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+index}:upsertDatapoints",
+"path": "v1beta1/{+endpoint}/embeddings",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest"
+"$ref": "GoogleApiHttpBody"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 }
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.operations.cancel",
+"id": "aiplatform.projects.locations.endpoints.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -12713,7 +12862,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12728,9 +12877,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.indexes.operations.delete",
+"id": "aiplatform.projects.locations.endpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -12738,7 +12887,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12753,9 +12902,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.operations.get",
+"id": "aiplatform.projects.locations.endpoints.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -12763,7 +12912,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12778,9 +12927,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.indexes.operations.list",
+"id": "aiplatform.projects.locations.endpoints.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -12793,7 +12942,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -12824,9 +12973,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.indexes.operations.wait",
+"id": "aiplatform.projects.locations.endpoints.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -12834,7 +12983,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -12857,60 +13006,49 @@
 }
 }
 },
-"metadataStores": {
+"evaluationItems": {
 "methods": {
 "create": {
-"description": "Initializes a MetadataStore, including allocation of resources.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores",
+"description": "Creates an Evaluation Item.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.create",
+"id": "aiplatform.projects.locations.evaluationItems.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"metadataStoreId": {
-"description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`",
+"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/metadataStores",
+"path": "v1beta1/{+parent}/evaluationItems",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1MetadataStore"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
+"description": "Deletes an Evaluation Item.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.delete",
+"id": "aiplatform.projects.locations.evaluationItems.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"deprecated": true,
-"description": "Deprecated: Field is no longer supported.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -12924,61 +13062,71 @@
 ]
 },
 "get": {
-"description": "Retrieves a specific MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
+"description": "Gets an Evaluation Item.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.get",
+"id": "aiplatform.projects.locations.evaluationItems.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1MetadataStore"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists MetadataStores for a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores",
+"description": "Lists Evaluation Items.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.list",
+"id": "aiplatform.projects.locations.evaluationItems.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
-"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "Optional. The maximum number of Evaluation Items to return.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/metadataStores",
+"path": "v1beta1/{+parent}/evaluationItems",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -12986,279 +13134,302 @@
 }
 },
 "resources": {
-"artifacts": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates an Artifact associated with a MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"artifactId": {
-"description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/artifacts",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Artifact"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1Artifact"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes an Artifact.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.delete",
+"id": "aiplatform.projects.locations.evaluationItems.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"etag": {
-"description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Retrieves a specific Artifact.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.get",
+"id": "aiplatform.projects.locations.evaluationItems.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Artifact"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Artifacts in the MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.list",
+"id": "aiplatform.projects.locations.evaluationItems.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/artifacts",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListArtifactsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a stored Artifact.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluationItems.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"allowMissing": {
-"description": "If set to true, and the Artifact is not found, a new Artifact is created.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Output only. The resource name of the Artifact.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. A FieldMask indicating which fields should be updated.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"evaluationRuns": {
+"methods": {
+"cancel": {
+"description": "Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.evaluationRuns.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Artifact"
+"$ref": "GoogleCloudAiplatformV1beta1CancelEvaluationRunRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Artifact"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"purge": {
-"description": "Purges Artifacts.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge",
+"create": {
+"description": "Creates an Evaluation Run.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.purge",
+"id": "aiplatform.projects.locations.evaluationRuns.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/artifacts:purge",
+"path": "v1beta1/{+parent}/evaluationRuns",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationRun"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationRun"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"queryArtifactLineageSubgraph": {
-"description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph",
+"delete": {
+"description": "Deletes an Evaluation Run.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.evaluationRuns.delete",
 "parameterOrder": [
-"artifact"
+"name"
 ],
 "parameters": {
-"artifact": {
-"description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
+"name": {
+"description": "Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
 "required": true,
 "type": "string"
-},
-"filter": {
-"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
-"location": "query",
-"type": "string"
-},
-"maxHops": {
-"description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.",
-"format": "int32",
-"location": "query",
-"type": "integer"
 }
 },
-"path": "v1beta1/{+artifact}:queryArtifactLineageSubgraph",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel",
+"get": {
+"description": "Gets an Evaluation Run.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationRuns.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "Required. The name of the EvaluationRun resource. Format: `projects/{project}/locations/{location}/evaluationRuns/{evaluation_run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationRun"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Evaluation Runs.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationRuns.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of Evaluation Runs to return.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/evaluationRuns",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationRunsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
+"resources": {
+"operations": {
+"methods": {
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete",
+"id": "aiplatform.projects.locations.evaluationRuns.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -13266,7 +13437,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13281,9 +13452,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get",
+"id": "aiplatform.projects.locations.evaluationRuns.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -13291,7 +13462,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13306,9 +13477,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list",
+"id": "aiplatform.projects.locations.evaluationRuns.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -13321,7 +13492,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13352,9 +13523,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationRuns/{evaluationRunsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait",
+"id": "aiplatform.projects.locations.evaluationRuns.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -13362,7 +13533,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationRuns/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13385,120 +13556,49 @@
 }
 }
 },
-"contexts": {
+"evaluationSets": {
 "methods": {
-"addContextArtifactsAndExecutions": {
-"description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions",
-"parameterOrder": [
-"context"
-],
-"parameters": {
-"context": {
-"description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+context}:addContextArtifactsAndExecutions",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"addContextChildren": {
-"description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren",
-"parameterOrder": [
-"context"
-],
-"parameters": {
-"context": {
-"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+context}:addContextChildren",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "create": {
-"description": "Creates a Context associated with a MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
+"description": "Creates an Evaluation Set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.create",
+"id": "aiplatform.projects.locations.evaluationSets.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"contextId": {
-"description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/contexts",
+"path": "v1beta1/{+parent}/evaluationSets",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Context"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Context"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a stored Context.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
+"description": "Deletes an Evaluation Set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.contexts.delete",
+"id": "aiplatform.projects.locations.evaluationSets.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"etag": {
-"description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
-"location": "query",
-"type": "string"
-},
-"force": {
-"description": "The force deletion semantics is still undefined. Users should not use this field.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"description": "Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13512,99 +13612,94 @@
 ]
 },
 "get": {
-"description": "Retrieves a specific Context.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
+"description": "Gets an Evaluation Set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.get",
+"id": "aiplatform.projects.locations.evaluationSets.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"description": "Required. The name of the EvaluationSet resource. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Context"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Contexts on the MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
+"description": "Lists Evaluation Sets.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.list",
+"id": "aiplatform.projects.locations.evaluationSets.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"description": "Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "Optional. The maximum number of Evaluation Sets to return.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/contexts",
+"path": "v1beta1/{+parent}/evaluationSets",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListContextsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationSetsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a stored Context.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
+"description": "Updates an Evaluation Set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.metadataStores.contexts.patch",
+"id": "aiplatform.projects.locations.evaluationSets.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"allowMissing": {
-"description": "If set to true, and the Context is not found, a new Context is created.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Immutable. The resource name of the Context.",
+"description": "Identifier. The resource name of the EvaluationSet. Format: `projects/{project}/locations/{location}/evaluationSets/{evaluation_set}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. A FieldMask indicating which fields should be updated.",
+"description": "Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -13612,130 +13707,159 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Context"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Context"
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationSet"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"purge": {
-"description": "Purges Contexts.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.purge",
-"parameterOrder": [
-"parent"
-],
+"resources": {
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.evaluationSets.operations.delete",
+"parameterOrder": [
+"name"
+],
 "parameters": {
-"parent": {
-"description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/contexts:purge",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PurgeContextsRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"queryContextLineageSubgraph": {
-"description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph",
+"id": "aiplatform.projects.locations.evaluationSets.operations.get",
 "parameterOrder": [
-"context"
+"name"
 ],
 "parameters": {
-"context": {
-"description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+context}:queryContextLineageSubgraph",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"removeContextChildren": {
-"description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.evaluationSets.operations.list",
 "parameterOrder": [
-"context"
+"name"
 ],
 "parameters": {
-"context": {
-"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+context}:removeContextChildren",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets/{evaluationSetsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel",
+"id": "aiplatform.projects.locations.evaluationSets.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationSets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
+"evaluationTasks": {
+"resources": {
+"operations": {
+"methods": {
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete",
+"id": "aiplatform.projects.locations.evaluationTasks.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -13743,7 +13867,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13758,9 +13882,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.get",
+"id": "aiplatform.projects.locations.evaluationTasks.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -13768,7 +13892,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13783,9 +13907,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.list",
+"id": "aiplatform.projects.locations.evaluationTasks.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -13798,7 +13922,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13829,9 +13953,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationTasks/{evaluationTasksId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait",
+"id": "aiplatform.projects.locations.evaluationTasks.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -13839,7 +13963,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluationTasks/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -13862,87 +13986,78 @@
 }
 }
 },
-"executions": {
+"exampleStores": {
 "methods": {
-"addExecutionEvents": {
-"description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents",
+"create": {
+"description": "Create an ExampleStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores:create",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents",
+"id": "aiplatform.projects.locations.exampleStores.create",
 "parameterOrder": [
-"execution"
+"parent"
 ],
 "parameters": {
-"execution": {
-"description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
-"required": true,
+"exampleStore.createTime": {
+"description": "Output only. Timestamp when this ExampleStore was created.",
+"format": "google-datetime",
+"location": "query",
 "type": "string"
-}
 },
-"path": "v1beta1/{+execution}:addExecutionEvents",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest"
+"exampleStore.description": {
+"description": "Optional. Description of the ExampleStore.",
+"location": "query",
+"type": "string"
 },
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse"
+"exampleStore.displayName": {
+"description": "Required. Display name of the ExampleStore.",
+"location": "query",
+"type": "string"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"exampleStore.exampleStoreConfig.vertexEmbeddingModel": {
+"description": "Required. The embedding model to be used for vector embedding. Immutable. Supported models: * \"text-embedding-005\" * \"text-multilingual-embedding-002\"",
+"location": "query",
+"type": "string"
 },
-"create": {
-"description": "Creates an Execution associated with a MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"executionId": {
-"description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)",
+"exampleStore.name": {
+"description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}",
+"location": "query",
+"type": "string"
+},
+"exampleStore.updateTime": {
+"description": "Output only. Timestamp when this ExampleStore was most recently updated.",
+"format": "google-datetime",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location to create the ExampleStore in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/executions",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Execution"
-},
+"path": "v1beta1/{+parent}/exampleStores:create",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Execution"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes an Execution.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"description": "Delete an ExampleStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.executions.delete",
+"id": "aiplatform.projects.locations.exampleStores.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"etag": {
-"description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"description": "Required. The resource name of the ExampleStore to be deleted. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -13955,100 +14070,118 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"fetchExamples": {
+"description": "Get Examples from the Example Store.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:fetchExamples",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.exampleStores.fetchExamples",
+"parameterOrder": [
+"exampleStore"
+],
+"parameters": {
+"exampleStore": {
+"description": "Required. The name of the ExampleStore resource that the examples should be fetched from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+exampleStore}:fetchExamples",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FetchExamplesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1FetchExamplesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
-"description": "Retrieves a specific Execution.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"description": "Get an ExampleStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.get",
+"id": "aiplatform.projects.locations.exampleStores.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"description": "Required. The resource name of the ExampleStore. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Execution"
+"$ref": "GoogleCloudAiplatformV1beta1ExampleStore"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Executions in the MetadataStore.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"description": "List ExampleStores in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.list",
+"id": "aiplatform.projects.locations.exampleStores.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"description": "Required. The resource name of the Location to list the ExampleStores from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/executions",
+"path": "v1beta1/{+parent}/exampleStores",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListExecutionsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListExampleStoresResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a stored Execution.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"description": "Update an ExampleStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.metadataStores.executions.patch",
+"id": "aiplatform.projects.locations.exampleStores.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"allowMissing": {
-"description": "If set to true, and the Execution is not found, a new Execution is created.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Output only. The resource name of the Execution.",
+"description": "Identifier. The resource name of the ExampleStore. This is a unique identifier. Format: projects/{project}/locations/{location}/exampleStores/{example_store}",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. A FieldMask indicating which fields should be updated.",
+"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -14056,63 +14189,94 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Execution"
+"$ref": "GoogleCloudAiplatformV1beta1ExampleStore"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Execution"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"purge": {
-"description": "Purges Executions.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge",
+"removeExamples": {
+"description": "Remove Examples from the Example Store.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:removeExamples",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.purge",
+"id": "aiplatform.projects.locations.exampleStores.removeExamples",
 "parameterOrder": [
-"parent"
+"exampleStore"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"exampleStore": {
+"description": "Required. The name of the ExampleStore resource that the examples should be removed from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/executions:purge",
+"path": "v1beta1/{+exampleStore}:removeExamples",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1RemoveExamplesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"queryExecutionInputsAndOutputs": {
-"description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs",
+"searchExamples": {
+"description": "Search for similar Examples for given selection criteria.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:searchExamples",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.exampleStores.searchExamples",
 "parameterOrder": [
-"execution"
+"exampleStore"
 ],
 "parameters": {
-"execution": {
-"description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"exampleStore": {
+"description": "Required. The name of the ExampleStore resource that examples are retrieved from. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+execution}:queryExecutionInputsAndOutputs",
+"path": "v1beta1/{+exampleStore}:searchExamples",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchExamplesRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph"
+"$ref": "GoogleCloudAiplatformV1beta1SearchExamplesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"upsertExamples": {
+"description": "Create or update Examples in the Example Store.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}:upsertExamples",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.exampleStores.upsertExamples",
+"parameterOrder": [
+"exampleStore"
+],
+"parameters": {
+"exampleStore": {
+"description": "Required. The name of the ExampleStore resource that examples are added to or updated in. Format: `projects/{project}/locations/{location}/exampleStores/{example_store}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+exampleStore}:upsertExamples",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1UpsertExamplesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -14124,9 +14288,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel",
+"id": "aiplatform.projects.locations.exampleStores.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -14134,7 +14298,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14149,9 +14313,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.delete",
+"id": "aiplatform.projects.locations.exampleStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -14159,7 +14323,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14174,9 +14338,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.get",
+"id": "aiplatform.projects.locations.exampleStores.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -14184,7 +14348,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14199,9 +14363,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.list",
+"id": "aiplatform.projects.locations.exampleStores.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -14214,7 +14378,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14245,9 +14409,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/exampleStores/{exampleStoresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.executions.operations.wait",
+"id": "aiplatform.projects.locations.exampleStores.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -14255,7 +14419,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exampleStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14278,180 +14442,268 @@
 }
 }
 },
-"metadataSchemas": {
+"extensionControllers": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a MetadataSchema.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create",
+"id": "aiplatform.projects.locations.extensionControllers.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"metadataSchemaId": {
-"description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"parent": {
-"description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.extensionControllers.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/metadataSchemas",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1MetadataSchema"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1MetadataSchema"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Retrieves a specific MetadataSchema.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get",
+"id": "aiplatform.projects.locations.extensionControllers.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1MetadataSchema"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists MetadataSchemas.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list",
+"id": "aiplatform.projects.locations.extensionControllers.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "A query to filter available MetadataSchemas for matching results.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensionControllers/{extensionControllersId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.extensionControllers.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensionControllers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/metadataSchemas",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
+}
+}
 },
-"operations": {
+"extensions": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.operations.cancel",
+"delete": {
+"description": "Deletes an Extension.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.extensions.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "Required. The name of the Extension resource to be deleted. Format: `projects/{project}/locations/{location}/extensions/{extension}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.metadataStores.operations.delete",
+"execute": {
+"description": "Executes the request against a given extension.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:execute",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.extensions.execute",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:execute",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1ExecuteExtensionResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
+"description": "Gets an Extension.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.operations.get",
+"id": "aiplatform.projects.locations.extensions.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the Extension resource. Format: `projects/{project}/locations/{location}/extensions/{extension}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
+"$ref": "GoogleCloudAiplatformV1beta1Extension"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Imports an Extension.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.extensions.import",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to import the Extension in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/extensions:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Extension"
+},
+"response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
@@ -14459,139 +14711,109 @@
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations",
+"description": "Lists Extensions in a location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.metadataStores.operations.list",
+"id": "aiplatform.projects.locations.extensions.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/extensions",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.metadataStores.operations.wait",
+"patch": {
+"description": "Updates an Extension.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.extensions.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Identifier. The resource name of the Extension.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-}
-}
-},
-"migratableResources": {
-"methods": {
-"batchMigrate": {
-"description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.batchMigrate",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/migratableResources:batchMigrate",
+"path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1Extension"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Extension"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"search": {
-"description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search",
+"query": {
+"description": "Queries an extension with a default controller.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.search",
+"id": "aiplatform.projects.locations.extensions.query",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/migratableResources:search",
+"path": "v1beta1/{+name}:query",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -14603,9 +14825,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.operations.cancel",
+"id": "aiplatform.projects.locations.extensions.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -14613,7 +14835,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14628,9 +14850,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.migratableResources.operations.delete",
+"id": "aiplatform.projects.locations.extensions.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -14638,7 +14860,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14653,9 +14875,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.migratableResources.operations.get",
+"id": "aiplatform.projects.locations.extensions.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -14663,7 +14885,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14678,9 +14900,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.migratableResources.operations.list",
+"id": "aiplatform.projects.locations.extensions.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -14693,7 +14915,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14724,9 +14946,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.migratableResources.operations.wait",
+"id": "aiplatform.projects.locations.extensions.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -14734,7 +14956,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -14757,49 +14979,59 @@
 }
 }
 },
-"modelDeploymentMonitoringJobs": {
+"featureGroups": {
 "methods": {
 "create": {
-"description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
+"description": "Creates a new FeatureGroup in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create",
+"id": "aiplatform.projects.locations.featureGroups.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"featureGroupId": {
+"description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"location": "query",
+"type": "string"
+},
 "parent": {
-"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs",
+"path": "v1beta1/{+parent}/featureGroups",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureGroup"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a ModelDeploymentMonitoringJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"description": "Deletes a single FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete",
+"id": "aiplatform.projects.locations.featureGroups.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -14813,95 +15045,125 @@
 ]
 },
 "get": {
-"description": "Gets a ModelDeploymentMonitoringJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"description": "Gets details of a single FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get",
+"id": "aiplatform.projects.locations.featureGroups.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"description": "Required. The name of the FeatureGroup resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureGroup"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists ModelDeploymentMonitoringJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
+"description": "Lists FeatureGroups in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list",
+"id": "aiplatform.projects.locations.featureGroups.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs",
+"path": "v1beta1/{+parent}/featureGroups",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a ModelDeploymentMonitoringJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"description": "Updates the parameters of a single FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch",
+"id": "aiplatform.projects.locations.featureGroups.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Resource name of a ModelDeploymentMonitoringJob.",
+"description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`",
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -14909,7 +15171,7 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureGroup"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -14918,239 +15180,225 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"pause": {
-"description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause",
+"id": "aiplatform.projects.locations.featureGroups.setIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:pause",
+"path": "v1beta1/{+resource}:setIamPolicy",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest"
+"$ref": "GoogleIamV1SetIamPolicyRequest"
 },
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"resume": {
-"description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume",
+"id": "aiplatform.projects.locations.featureGroups.testIamPermissions",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:resume",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest"
-},
+"path": "v1beta1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"searchModelDeploymentMonitoringStatsAnomalies": {
-"description": "Searches Model Monitoring Statistics generated within a given time window.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies",
+"resources": {
+"featureMonitors": {
+"methods": {
+"create": {
+"description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.create",
 "parameterOrder": [
-"modelDeploymentMonitoringJob"
+"parent"
 ],
 "parameters": {
-"modelDeploymentMonitoringJob": {
-"description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"featureMonitorId": {
+"description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies",
+"path": "v1beta1/{+parent}/featureMonitors",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel",
+"delete": {
+"description": "Deletes a single FeatureMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete",
+"get": {
+"description": "Gets details of a single FeatureMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the FeatureMonitor resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations",
+"description": "Lists FeatureGroups in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/featureMonitors",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait",
+"patch": {
+"description": "Updates the parameters of a single FeatureMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -15158,114 +15406,190 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
 },
-"modelMonitors": {
+"resources": {
+"featureMonitorJobs": {
 "methods": {
 "create": {
-"description": "Creates a ModelMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors",
+"description": "Creates a new feature monitor job.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelMonitors.create",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"modelMonitorId": {
-"description": "Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
+"featureMonitorJobId": {
+"description": "Optional. Output only. System-generated ID for feature monitor job.",
+"format": "int64",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/modelMonitors",
+"path": "v1beta1/{+parent}/featureMonitorJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelMonitor"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a ModelMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelMonitors.delete",
+"get": {
+"description": "Get a feature monitor job.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "Optional. Force delete the model monitor with schedules.",
+"name": {
+"description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "List feature monitor jobs.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01.",
 "location": "query",
-"type": "boolean"
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+parent}/featureMonitorJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
 "name": {
-"description": "Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a ModelMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelMonitors.get",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelMonitor"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists ModelMonitors in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelMonitors.list",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -15277,168 +15601,131 @@
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/modelMonitors",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a ModelMonitor.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.modelMonitors.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Required. Mask specifying which fields to update.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelMonitor"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"searchModelMonitoringAlerts": {
-"description": "Returns the Model Monitoring alerts.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts",
-"parameterOrder": [
-"modelMonitor"
-],
-"parameters": {
-"modelMonitor": {
-"description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
-"required": true,
-"type": "string"
+}
+}
+}
 }
 },
-"path": "v1beta1/{+modelMonitor}:searchModelMonitoringAlerts",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"searchModelMonitoringStats": {
-"description": "Searches Model Monitoring Stats generated within a given time window.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats",
+"features": {
+"methods": {
+"batchCreate": {
+"description": "Creates a batch of Features in a given FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats",
+"id": "aiplatform.projects.locations.featureGroups.features.batchCreate",
 "parameterOrder": [
-"modelMonitor"
+"parent"
 ],
 "parameters": {
-"modelMonitor": {
-"description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"parent": {
+"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+modelMonitor}:searchModelMonitoringStats",
+"path": "v1beta1/{+parent}/features:batchCreate",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"modelMonitoringJobs": {
-"methods": {
 "create": {
-"description": "Creates a ModelMonitoringJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs",
+"description": "Creates a new Feature in a given FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create",
+"id": "aiplatform.projects.locations.featureGroups.features.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"modelMonitoringJobId": {
-"description": "Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
+"featureId": {
+"description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`",
+"description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/modelMonitoringJobs",
+"path": "v1beta1/{+parent}/features",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a ModelMonitoringJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}",
+"description": "Deletes a single Feature.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete",
+"id": "aiplatform.projects.locations.featureGroups.features.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`",
+"description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15452,111 +15739,149 @@
 ]
 },
 "get": {
-"description": "Gets a ModelMonitoringJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}",
+"description": "Gets details of a single Feature.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get",
+"id": "aiplatform.projects.locations.featureGroups.features.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"featureStatsAndAnomalySpec.latestStatsCount": {
+"description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"featureStatsAndAnomalySpec.statsTimeRange.endTime": {
+"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
+},
+"featureStatsAndAnomalySpec.statsTimeRange.startTime": {
+"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`",
+"description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob"
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs",
+"description": "Lists Features in a given FeatureGroup.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list",
+"id": "aiplatform.projects.locations.featureGroups.features.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.",
+"location": "query",
+"type": "string"
+},
+"latestStatsCount": {
+"description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
 },
 "readMask": {
-"description": "Mask specifying which fields to read",
+"description": "Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/modelMonitoringJobs",
+"path": "v1beta1/{+parent}/features",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelMonitors.operations.cancel",
+"patch": {
+"description": "Updates the parameters of a single Feature.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureGroups.features.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
+"resources": {
+"operations": {
+"methods": {
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.modelMonitors.operations.delete",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -15564,7 +15889,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15579,9 +15904,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelMonitors.operations.get",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -15589,7 +15914,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15604,9 +15929,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.modelMonitors.operations.list",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -15619,7 +15944,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -15650,9 +15975,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.modelMonitors.operations.wait",
+"id": "aiplatform.projects.locations.featureGroups.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -15660,7 +15985,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -15683,49 +16008,46 @@
 }
 }
 },
-"models": {
+"operations": {
 "methods": {
-"copy": {
-"description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.copy",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureGroups.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/models:copy",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CopyModelRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.delete",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -15738,296 +16060,272 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"deleteVersion": {
-"description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.deleteVersion",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureGroups.operations.list",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}:deleteVersion",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"export": {
-"description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.export",
+"id": "aiplatform.projects.locations.featureGroups.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+name}:export",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExportModelRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"get": {
-"description": "Gets a Model.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.get",
+"featureOnlineStores": {
+"methods": {
+"create": {
+"description": "Creates a new FeatureOnlineStore in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.",
+"featureOnlineStoreId": {
+"description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/featureOnlineStores",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Model"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.getIamPolicy",
+"delete": {
+"description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureOnlineStores.delete",
 "parameterOrder": [
-"resource"
+"name"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
+"force": {
+"description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)",
 "location": "query",
-"type": "integer"
+"type": "boolean"
 },
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"name": {
+"description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:getIamPolicy",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists Models in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models",
+"get": {
+"description": "Gets details of a single FeatureOnlineStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.get",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "Required. The name of the FeatureOnlineStore resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/models",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listCheckpoints": {
-"description": "Lists checkpoints of the specified model version.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.listCheckpoints",
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The standard list page size.",
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
-"pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.",
-"location": "query",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:listCheckpoints",
+"path": "v1beta1/{+resource}:getIamPolicy",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listVersions": {
-"description": "Lists versions of the specified model.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions",
+"list": {
+"description": "Lists FeatureOnlineStores in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.listVersions",
+"id": "aiplatform.projects.locations.featureOnlineStores.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`",
+"description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "Required. The name of the model to list versions for.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-},
 "orderBy": {
-"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.",
-"location": "query",
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.",
 "location": "query",
 "type": "string"
-}
-},
-"path": "v1beta1/{+name}:listVersions",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 },
-"mergeVersionAliases": {
-"description": "Merges a set of aliases for a Model version.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.mergeVersionAliases",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"parent": {
+"description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:mergeVersionAliases",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest"
-},
+"path": "v1beta1/{+parent}/featureOnlineStores",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Model"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a Model.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
+"description": "Updates the parameters of a single FeatureOnlineStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.models.patch",
+"id": "aiplatform.projects.locations.featureOnlineStores.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The resource name of the Model.",
+"description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -16035,10 +16333,10 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Model"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Model"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -16046,9 +16344,9 @@
 },
 "setIamPolicy": {
 "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.setIamPolicy",
+"id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy",
 "parameterOrder": [
 "resource"
 ],
@@ -16056,7 +16354,7 @@
 "resource": {
 "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16074,9 +16372,9 @@
 },
 "testIamPermissions": {
 "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.testIamPermissions",
+"id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions",
 "parameterOrder": [
 "resource"
 ],
@@ -16090,7 +16388,7 @@
 "resource": {
 "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16102,55 +16400,41 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"updateExplanationDataset": {
-"description": "Incrementally update the dataset used for an examples model.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.updateExplanationDataset",
-"parameterOrder": [
-"model"
-],
-"parameters": {
-"model": {
-"description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
 }
 },
-"path": "v1beta1/{+model}:updateExplanationDataset",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"upload": {
-"description": "Uploads a Model artifact into Vertex AI.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload",
+"resources": {
+"featureViews": {
+"methods": {
+"create": {
+"description": "Creates a new FeatureView in a given FeatureOnlineStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.upload",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"featureViewId": {
+"description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.",
+"location": "query",
+"type": "string"
+},
 "parent": {
-"description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"runSyncImmediately": {
+"description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/models:upload",
+"path": "v1beta1/{+parent}/featureViews",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1UploadModelRequest"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureView"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -16158,407 +16442,479 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"evaluations": {
-"methods": {
-"get": {
-"description": "Gets a ModelEvaluation.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.get",
+"delete": {
+"description": "Deletes a single FeatureView.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"import": {
-"description": "Imports an externally generated ModelEvaluation.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import",
+"directWrite": {
+"description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.import",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite",
 "parameterOrder": [
-"parent"
+"featureView"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`",
+"featureView": {
+"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/evaluations:import",
+"path": "v1beta1/{+featureView}:directWrite",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists ModelEvaluations in a Model.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.list",
+"fetchFeatureValues": {
+"description": "Fetch feature values under a FeatureView.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues",
 "parameterOrder": [
-"parent"
+"featureView"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`",
+"featureView": {
+"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/evaluations",
+"path": "v1beta1/{+featureView}:fetchFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel",
+"generateFetchAccessToken": {
+"description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.operations.cancel",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken",
 "parameterOrder": [
-"name"
+"featureView"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"featureView": {
+"description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+featureView}:generateFetchAccessToken",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.evaluations.operations.delete",
+"get": {
+"description": "Gets details of a single FeatureView.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureView"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.operations.get",
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+resource}:getIamPolicy",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations",
+"description": "Lists FeatureViews in a given FeatureOnlineStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.operations.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/featureViews",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.operations.wait",
+"patch": {
+"description": "Updates the parameters of a single FeatureView.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FeatureView"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"searchNearestEntities": {
+"description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities",
+"parameterOrder": [
+"featureView"
+],
+"parameters": {
+"featureView": {
+"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"required": true,
+"type": "string"
 }
+},
+"path": "v1beta1/{+featureView}:searchNearestEntities",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"slices": {
-"methods": {
-"batchImport": {
-"description": "Imports a list of externally generated EvaluatedAnnotations.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport",
+"path": "v1beta1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"streamingFetchFeatureValues": {
+"description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.evaluations.slices.batchImport",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues",
 "parameterOrder": [
-"parent"
+"featureView"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
+"featureView": {
+"description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}:batchImport",
+"path": "v1beta1/{+featureView}:streamingFetchFeatureValues",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"sync": {
+"description": "Triggers on-demand sync for the FeatureView.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync",
+"parameterOrder": [
+"featureView"
+],
+"parameters": {
+"featureView": {
+"description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+featureView}:sync",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:testIamPermissions",
+"response": {
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
+"resources": {
+"featureViewSyncs": {
+"methods": {
 "get": {
-"description": "Gets a ModelEvaluationSlice.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}",
+"description": "Gets details of a single FeatureViewSync.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.slices.get",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
+"description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice"
+"$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists ModelEvaluationSlices in a ModelEvaluation.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices",
+"description": "Lists FeatureViewSyncs in a given FeatureView.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.evaluations.slices.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. * `slice.dimension` - for =.",
+"description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.",
+"description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/slices",
+"path": "v1beta1/{+parent}/featureViewSyncs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
-}
-}
 },
 "operations": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.models.operations.delete",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -16566,7 +16922,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16581,9 +16937,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.operations.get",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -16591,7 +16947,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16606,9 +16962,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.models.operations.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -16621,7 +16977,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -16652,9 +17008,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.models.operations.wait",
+"id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -16662,7 +17018,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -16685,129 +17041,79 @@
 }
 }
 },
-"nasJobs": {
+"operations": {
 "methods": {
-"cancel": {
-"description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.nasJobs.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelNasJobRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a NasJob",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.nasJobs.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/nasJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1NasJob"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1NasJob"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
-"description": "Deletes a NasJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.nasJobs.delete",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a NasJob",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.get",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1NasJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists NasJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.list",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
 "description": "The standard list page size.",
 "format": "int32",
@@ -16815,128 +17121,114 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featureOnlineStores.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/nasJobs",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListNasJobsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
-"nasTrialDetails": {
+"featurestores": {
 "methods": {
-"get": {
-"description": "Gets a NasTrialDetail.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get",
+"batchReadFeatureValues": {
+"description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues",
 "parameterOrder": [
-"name"
+"featurestore"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`",
+"featurestore": {
+"description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+featurestore}:batchReadFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1NasTrialDetail"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "List top NasTrialDetails of a NasJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list",
+"create": {
+"description": "Creates a new Featurestore in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.",
+"featurestoreId": {
+"description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/nasTrialDetails",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-}
-}
-},
-"notebookExecutionJobs": {
-"methods": {
-"create": {
-"description": "Creates a NotebookExecutionJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"notebookExecutionJobId": {
-"description": "Optional. User specified ID for the NotebookExecutionJob.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/notebookExecutionJobs",
+"path": "v1beta1/{+parent}/featurestores",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob"
+"$ref": "GoogleCloudAiplatformV1beta1Featurestore"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -16946,18 +17238,23 @@
 ]
 },
 "delete": {
-"description": "Deletes a NotebookExecutionJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
+"description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.delete",
+"id": "aiplatform.projects.locations.featurestores.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the NotebookExecutionJob resource to be deleted.",
+"description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -16970,350 +17267,329 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateAccessToken": {
-"description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:generateAccessToken",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken",
+"get": {
+"description": "Gets details of a single Featurestore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featurestores.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`",
+"description": "Required. The name of the Featurestore resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:generateAccessToken",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse"
+"$ref": "GoogleCloudAiplatformV1beta1Featurestore"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a NotebookExecutionJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.get",
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.getIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the NotebookExecutionJob resource.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
-},
-"view": {
-"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
-"enum": [
-"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
-"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
-"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
-],
-"enumDescriptions": [
-"When unspecified, the API defaults to the BASIC view.",
-"Includes all fields except for direct notebook inputs.",
-"Includes all fields."
-],
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+resource}:getIamPolicy",
+"request": {
+"$ref": "GoogleIamV1GetIamPolicyRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists NotebookExecutionJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"description": "Lists Featurestores in a given project and location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.list",
+"id": "aiplatform.projects.locations.featurestores.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`",
+"description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.",
+"description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"view": {
-"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
-"enum": [
-"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
-"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
-"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
-],
-"enumDescriptions": [
-"When unspecified, the API defaults to the BASIC view.",
-"Includes all fields except for direct notebook inputs.",
-"Includes all fields."
-],
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/notebookExecutionJobs",
+"path": "v1beta1/{+parent}/featurestores",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"reportEvent": {
-"description": "",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:reportEvent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.reportEvent",
+"patch": {
+"description": "Updates the parameters of a single Featurestore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featurestores.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`",
+"description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}:reportEvent",
+"path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest"
+"$ref": "GoogleCloudAiplatformV1beta1Featurestore"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel",
+"searchFeatures": {
+"description": "Searches Features matching a query in a given project.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featurestores.searchFeatures",
 "parameterOrder": [
-"name"
+"location"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"location": {
+"description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pageSize": {
+"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"query": {
+"description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+location}/featurestores:searchFeatures",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.setIamPolicy",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.testIamPermissions",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+resource}:testIamPermissions",
+"request": {
+"$ref": "GoogleIamV1TestIamPermissionsRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list",
+"resources": {
+"entityTypes": {
+"methods": {
+"create": {
+"description": "Creates a new EntityType in a given Featurestore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
+"entityTypeId": {
+"description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
+"parent": {
+"description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/entityTypes",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1EntityType"
+},
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait",
+"delete": {
+"description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"notebookRuntimeTemplates": {
-"methods": {
-"create": {
-"description": "Creates a NotebookRuntimeTemplate.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
+"deleteFeatureValues": {
+"description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.create",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues",
 "parameterOrder": [
-"parent"
+"entityType"
 ],
 "parameters": {
-"notebookRuntimeTemplateId": {
-"description": "Optional. User specified ID for the notebook runtime template.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`",
+"entityType": {
+"description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/notebookRuntimeTemplates",
+"path": "v1beta1/{+entityType}:deleteFeatureValues",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+"$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -17322,24 +17598,27 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a NotebookRuntimeTemplate.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete",
+"exportFeatureValues": {
+"description": "Exports Feature values from all the entities of a target EntityType.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues",
 "parameterOrder": [
-"name"
+"entityType"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
+"entityType": {
+"description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+entityType}:exportFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -17348,25 +17627,25 @@
 ]
 },
 "get": {
-"description": "Gets a NotebookRuntimeTemplate.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"description": "Gets details of a single EntityType.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
+"description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+"$ref": "GoogleCloudAiplatformV1beta1EntityType"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -17374,9 +17653,9 @@
 },
 "getIamPolicy": {
 "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy",
 "parameterOrder": [
 "resource"
 ],
@@ -17390,7 +17669,7 @@
 "resource": {
 "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17403,76 +17682,104 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"importFeatureValues": {
+"description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues",
+"parameterOrder": [
+"entityType"
+],
+"parameters": {
+"entityType": {
+"description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+entityType}:importFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
-"description": "Lists NotebookRuntimeTemplates in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
+"description": "Lists EntityTypes in a given Featurestore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.list",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
+"description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.",
+"description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 },
 "readMask": {
-"description": "Optional. Mask specifying which fields to read.",
+"description": "Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/notebookRuntimeTemplates",
+"path": "v1beta1/{+parent}/entityTypes",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a NotebookRuntimeTemplate.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"description": "Updates the parameters of a single EntityType.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The resource name of the NotebookRuntimeTemplate.",
+"description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`",
+"description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -17480,256 +17787,215 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+"$ref": "GoogleCloudAiplatformV1beta1EntityType"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+"$ref": "GoogleCloudAiplatformV1beta1EntityType"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy",
+"readFeatureValues": {
+"description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues",
 "parameterOrder": [
-"resource"
+"entityType"
 ],
 "parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"entityType": {
+"description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:setIamPolicy",
+"path": "v1beta1/{+entityType}:readFeatureValues",
 "request": {
-"$ref": "GoogleIamV1SetIamPolicyRequest"
+"$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest"
 },
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions",
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy",
 "parameterOrder": [
 "resource"
 ],
 "parameters": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"location": "query",
-"repeated": true,
-"type": "string"
-},
 "resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:testIamPermissions",
+"path": "v1beta1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
 "response": {
-"$ref": "GoogleIamV1TestIamPermissionsResponse"
+"$ref": "GoogleIamV1Policy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel",
+"streamingReadFeatureValues": {
+"description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues",
 "parameterOrder": [
-"name"
+"entityType"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"entityType": {
+"description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+entityType}:streamingReadFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete",
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions",
 "parameterOrder": [
-"name"
+"resource"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
-"required": true,
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+resource}:testIamPermissions",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list",
+"writeFeatureValues": {
+"description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues",
 "parameterOrder": [
-"name"
+"entityType"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
+"entityType": {
+"description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+entityType}:writeFeatureValues",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait",
+"resources": {
+"features": {
+"methods": {
+"batchCreate": {
+"description": "Creates a batch of Features in a given EntityType.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"parent": {
+"description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+parent}/features:batchCreate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"notebookRuntimes": {
-"methods": {
-"assign": {
-"description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign",
+"create": {
+"description": "Creates a new Feature in a given EntityType.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.assign",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"featureId": {
+"description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.",
+"location": "query",
+"type": "string"
+},
 "parent": {
-"description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/notebookRuntimes:assign",
+"path": "v1beta1/{+parent}/features",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest"
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -17739,18 +18005,18 @@
 ]
 },
 "delete": {
-"description": "Deletes a NotebookRuntime.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
+"description": "Deletes a single Feature.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimes.delete",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -17763,218 +18029,136 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateAccessToken": {
-"description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.generateAccessToken",
+"get": {
+"description": "Gets details of a single Feature.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:generateAccessToken",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest"
+"featureStatsAndAnomalySpec.latestStatsCount": {
+"description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse"
+"featureStatsAndAnomalySpec.statsTimeRange.endTime": {
+"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"featureStatsAndAnomalySpec.statsTimeRange.startTime": {
+"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
 },
-"get": {
-"description": "Gets a NotebookRuntime.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
 "name": {
-"description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime"
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists NotebookRuntimes in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes",
+"description": "Lists Features in a given EntityType.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.list",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
+"description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.",
 "location": "query",
 "type": "string"
 },
+"latestStatsCount": {
+"description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
 "orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.",
+"description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
 "readMask": {
-"description": "Optional. Mask specifying which fields to read.",
+"description": "Mask specifying which fields to read.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/notebookRuntimes",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"reportEvent": {
-"description": "",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.reportEvent",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:reportEvent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"start": {
-"description": "Starts a NotebookRuntime.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.start",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:start",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest"
-},
+"path": "v1beta1/{+parent}/features",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"stop": {
-"description": "Stops a NotebookRuntime.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.stop",
+"patch": {
+"description": "Updates the parameters of a single Feature.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+name}:stop",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 },
-"upgrade": {
-"description": "Upgrades a NotebookRuntime.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.upgrade",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
-"required": true,
+"updateMask": {
+"description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)",
+"format": "google-fieldmask",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:upgrade",
+"path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest"
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Feature"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -17986,9 +18170,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -17996,7 +18180,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18011,9 +18195,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.delete",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -18021,7 +18205,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18036,9 +18220,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -18046,7 +18230,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18061,9 +18245,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.list",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -18076,7 +18260,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18107,9 +18291,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.notebookRuntimes.operations.wait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -18117,7 +18301,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18144,9 +18328,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.operations.cancel",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -18154,7 +18338,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18169,9 +18353,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.operations.delete",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -18179,7 +18363,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18194,9 +18378,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.operations.get",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -18204,7 +18388,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18219,9 +18403,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.operations.list",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -18234,7 +18418,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18265,9 +18449,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.operations.wait",
+"id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -18275,7 +18459,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18295,257 +18479,74 @@
 ]
 }
 }
+}
+}
 },
-"persistentResources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a PersistentResource.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.create",
+"id": "aiplatform.projects.locations.featurestores.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"persistentResourceId": {
-"description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/persistentResources",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PersistentResource"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a PersistentResource.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.persistentResources.delete",
+"id": "aiplatform.projects.locations.featurestores.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a PersistentResource.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.get",
+"id": "aiplatform.projects.locations.featurestores.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1PersistentResource"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists PersistentResources in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"pageSize": {
-"description": "Optional. The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/persistentResources",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates a PersistentResource.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.persistentResources.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Immutable. Resource name of a PersistentResource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PersistentResource"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"reboot": {
-"description": "Reboots a PersistentResource.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.reboot",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:reboot",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.persistentResources.operations.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.operations.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18560,9 +18561,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.persistentResources.operations.list",
+"id": "aiplatform.projects.locations.featurestores.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -18575,7 +18576,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18606,9 +18607,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.persistentResources.operations.wait",
+"id": "aiplatform.projects.locations.featurestores.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -18616,7 +18617,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18639,84 +18640,28 @@
 }
 }
 },
-"pipelineJobs": {
+"hyperparameterTuningJobs": {
 "methods": {
-"batchCancel": {
-"description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.batchCancel",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/pipelineJobs:batchCancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"batchDelete": {
-"description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.batchDelete",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/pipelineJobs:batchDelete",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "cancel": {
-"description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel",
+"description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.cancel",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest"
+"$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest"
 },
 "response": {
 "$ref": "GoogleProtobufEmpty"
@@ -18726,51 +18671,46 @@
 ]
 },
 "create": {
-"description": "Creates a PipelineJob. A PipelineJob will run immediately when created.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
+"description": "Creates a HyperparameterTuningJob",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.create",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"pipelineJobId": {
-"description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/pipelineJobs",
+"path": "v1beta1/{+parent}/hyperparameterTuningJobs",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PipelineJob"
+"$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PipelineJob"
+"$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a PipelineJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"description": "Deletes a HyperparameterTuningJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.pipelineJobs.delete",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18784,46 +18724,41 @@
 ]
 },
 "get": {
-"description": "Gets a PipelineJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"description": "Gets a HyperparameterTuningJob",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.get",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PipelineJob"
+"$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists PipelineJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
+"description": "Lists HyperparameterTuningJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.list",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
 "location": "query",
 "type": "string"
 },
@@ -18834,12 +18769,12 @@
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.",
+"description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -18852,9 +18787,9 @@
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/pipelineJobs",
+"path": "v1beta1/{+parent}/hyperparameterTuningJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -18866,9 +18801,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.cancel",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -18876,7 +18811,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18891,9 +18826,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.delete",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -18901,7 +18836,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18916,9 +18851,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.get",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -18926,7 +18861,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -18941,9 +18876,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.list",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -18956,7 +18891,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -18987,9 +18922,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.pipelineJobs.operations.wait",
+"id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -18997,7 +18932,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19020,95 +18955,81 @@
 }
 }
 },
-"publishers": {
-"resources": {
-"models": {
+"indexEndpoints": {
 "methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens",
+"create": {
+"description": "Creates an IndexEndpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.computeTokens",
+"id": "aiplatform.projects.locations.indexEndpoints.create",
 "parameterOrder": [
-"endpoint"
+"parent"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"parent": {
+"description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:computeTokens",
+"path": "v1beta1/{+parent}/indexEndpoints",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
+"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.countTokens",
+"delete": {
+"description": "Deletes an IndexEndpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.indexEndpoints.delete",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"export": {
-"description": "Exports a publisher model to a user provided Google Cloud Storage bucket.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export",
+"deployIndex": {
+"description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.export",
+"id": "aiplatform.projects.locations.indexEndpoints.deployIndex",
 "parameterOrder": [
-"parent",
-"name"
+"indexEndpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-},
-"parent": {
-"description": "Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`",
+"indexEndpoint": {
+"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/{+name}:export",
+"path": "v1beta1/{+indexEndpoint}:deployIndex",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest"
+"$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -19117,257 +19038,296 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
+"findNeighbors": {
+"description": "Finds the nearest neighbors of each vector within the request.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation",
+"id": "aiplatform.projects.locations.indexEndpoints.findNeighbors",
 "parameterOrder": [
-"endpoint"
+"indexEndpoint"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"indexEndpoint": {
+"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:fetchPredictOperation",
+"path": "v1beta1/{+indexEndpoint}:findNeighbors",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
+"$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"fetchPublisherModelConfig": {
-"description": "Fetches the configs of publisher models.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPublisherModelConfig",
+"get": {
+"description": "Gets an IndexEndpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.publishers.models.fetchPublisherModelConfig",
+"id": "aiplatform.projects.locations.indexEndpoints.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
+"description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:fetchPublisherModelConfig",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig"
+"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.generateContent",
+"list": {
+"description": "Lists IndexEndpoints in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.indexEndpoints.list",
 "parameterOrder": [
-"model"
+"parent"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
-"required": true,
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`",
+"location": "query",
 "type": "string"
-}
 },
-"path": "v1beta1/{+model}:generateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.",
+"location": "query",
+"type": "string"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"parent": {
+"description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/indexEndpoints",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy",
+"mutateDeployedIndex": {
+"description": "Update an existing DeployedIndex under an IndexEndpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.getIamPolicy",
+"id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex",
 "parameterOrder": [
-"resource"
+"indexEndpoint"
 ],
 "parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"indexEndpoint": {
+"description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+resource}:getIamPolicy",
+"path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1DeployedIndex"
+},
 "response": {
-"$ref": "GoogleIamV1Policy"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.predict",
+"patch": {
+"description": "Updates an IndexEndpoint.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.indexEndpoints.patch",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "Output only. The resource name of the IndexEndpoint.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:predict",
+"path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
+"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
+"$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
+"readIndexDatapoints": {
+"description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.predictLongRunning",
+"id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints",
 "parameterOrder": [
-"endpoint"
+"indexEndpoint"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"indexEndpoint": {
+"description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:predictLongRunning",
+"path": "v1beta1/{+indexEndpoint}:readIndexDatapoints",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
+"$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"rawPredict": {
-"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict",
+"undeployIndex": {
+"description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.rawPredict",
+"id": "aiplatform.projects.locations.indexEndpoints.undeployIndex",
 "parameterOrder": [
-"endpoint"
+"indexEndpoint"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"indexEndpoint": {
+"description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:rawPredict",
+"path": "v1beta1/{+indexEndpoint}:undeployIndex",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest"
+"$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest"
 },
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"serverStreamingPredict": {
-"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:serverStreamingPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setPublisherModelConfig": {
-"description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:setPublisherModelConfig",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.setPublisherModelConfig",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:setPublisherModelConfig",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest"
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -19375,90 +19335,109 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.streamGenerateContent",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.list",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamRawPredict": {
-"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.publishers.models.streamRawPredict",
+"id": "aiplatform.projects.locations.indexEndpoints.operations.wait",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+endpoint}:streamRawPredict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
 }
 }
 },
-"ragCorpora": {
+"indexes": {
 "methods": {
 "create": {
-"description": "Creates a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
+"description": "Creates an Index.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.create",
+"id": "aiplatform.projects.locations.indexes.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/ragCorpora",
+"path": "v1beta1/{+parent}/indexes",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1RagCorpus"
+"$ref": "GoogleCloudAiplatformV1beta1Index"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -19468,23 +19447,18 @@
 ]
 },
 "delete": {
-"description": "Deletes a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.delete",
+"id": "aiplatform.projects.locations.indexes.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19498,86 +19472,131 @@
 ]
 },
 "get": {
-"description": "Gets a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"description": "Gets an Index.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.get",
+"id": "aiplatform.projects.locations.indexes.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1RagCorpus"
+"$ref": "GoogleCloudAiplatformV1beta1Index"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Imports an Index from an external source (e.g., BigQuery).",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexes.import",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists RagCorpora in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
+"description": "Lists Indexes in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.list",
+"id": "aiplatform.projects.locations.indexes.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.",
+"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/ragCorpora",
+"path": "v1beta1/{+parent}/indexes",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"description": "Updates an Index.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.ragCorpora.patch",
+"id": "aiplatform.projects.locations.indexes.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. The resource name of the RagCorpus.",
+"description": "Output only. The resource name of the Index.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1RagCorpus"
+"$ref": "GoogleCloudAiplatformV1beta1Index"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -19585,6 +19604,62 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"removeDatapoints": {
+"description": "Remove Datapoints from an Index.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexes.removeDatapoints",
+"parameterOrder": [
+"index"
+],
+"parameters": {
+"index": {
+"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+index}:removeDatapoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"upsertDatapoints": {
+"description": "Add/update Datapoints into an Index.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.indexes.upsertDatapoints",
+"parameterOrder": [
+"index"
+],
+"parameters": {
+"index": {
+"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+index}:upsertDatapoints",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -19592,9 +19667,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.operations.cancel",
+"id": "aiplatform.projects.locations.indexes.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -19602,7 +19677,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19617,9 +19692,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.operations.delete",
+"id": "aiplatform.projects.locations.indexes.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -19627,7 +19702,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19642,9 +19717,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.operations.get",
+"id": "aiplatform.projects.locations.indexes.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -19652,7 +19727,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -19667,9 +19742,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.operations.list",
+"id": "aiplatform.projects.locations.indexes.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -19682,7 +19757,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19713,9 +19788,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.operations.wait",
+"id": "aiplatform.projects.locations.indexes.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -19723,7 +19798,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -19743,32 +19818,37 @@
 ]
 }
 }
+}
+}
 },
-"ragFiles": {
+"metadataStores": {
 "methods": {
-"delete": {
-"description": "Deletes a RagFile.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete",
+"create": {
+"description": "Initializes a MetadataStore, including allocation of resources.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"forceDelete": {
-"description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.",
+"metadataStoreId": {
+"description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)",
 "location": "query",
-"type": "boolean"
+"type": "string"
 },
-"name": {
-"description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
+"parent": {
+"description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/metadataStores",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1MetadataStore"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -19776,90 +19856,93 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets a RagFile.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.get",
+"delete": {
+"description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"force": {
+"deprecated": true,
+"description": "Deprecated: Field is no longer supported.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
+"description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1RagFile"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"import": {
-"description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.import",
+"get": {
+"description": "Retrieves a specific MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.get",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"name": {
+"description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/ragFiles:import",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1MetadataStore"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists RagFiles in a RagCorpus.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles",
+"description": "Lists MetadataStores for a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.list",
+"id": "aiplatform.projects.locations.metadataStores.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.",
+"description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/ragFiles",
+"path": "v1beta1/{+parent}/metadataStores",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListMetadataStoresResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -19867,175 +19950,254 @@
 }
 },
 "resources": {
-"operations": {
+"artifacts": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel",
+"create": {
+"description": "Creates an Artifact associated with a MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
+"artifactId": {
+"description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+parent}/artifacts",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Artifact"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1Artifact"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
+"description": "Deletes an Artifact.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"etag": {
+"description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
+"description": "Retrieves a specific Artifact.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Artifact"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations",
+"description": "Lists Artifacts in the MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
-"required": true,
+"orderBy": {
+"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
+"location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size.",
+"description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
+"parent": {
+"description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/artifacts",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListArtifactsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait",
+"patch": {
+"description": "Updates a stored Artifact.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"allowMissing": {
+"description": "If set to true, and the Artifact is not found, a new Artifact is created.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Output only. The resource name of the Artifact.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Optional. A FieldMask indicating which fields should be updated.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Artifact"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Artifact"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"purge": {
+"description": "Purges Artifacts.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.purge",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
 }
+},
+"path": "v1beta1/{+parent}/artifacts:purge",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PurgeArtifactsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"queryArtifactLineageSubgraph": {
+"description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph",
+"parameterOrder": [
+"artifact"
+],
+"parameters": {
+"artifact": {
+"description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
+"required": true,
+"type": "string"
+},
+"filter": {
+"description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"location": "query",
+"type": "string"
+},
+"maxHops": {
+"description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 }
-}
-}
-}
+},
+"path": "v1beta1/{+artifact}:queryArtifactLineageSubgraph",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
-"ragEngineConfig": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -20043,7 +20205,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20058,9 +20220,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.delete",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -20068,7 +20230,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20083,9 +20245,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.get",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -20093,7 +20255,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20108,9 +20270,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.list",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -20123,7 +20285,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20154,9 +20316,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.ragEngineConfig.operations.wait",
+"id": "aiplatform.projects.locations.metadataStores.artifacts.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -20164,7 +20326,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20187,54 +20349,120 @@
 }
 }
 },
-"reasoningEngines": {
+"contexts": {
 "methods": {
+"addContextArtifactsAndExecutions": {
+"description": "Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextArtifactsAndExecutions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions",
+"parameterOrder": [
+"context"
+],
+"parameters": {
+"context": {
+"description": "Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+context}:addContextArtifactsAndExecutions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1AddContextArtifactsAndExecutionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"addContextChildren": {
+"description": "Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:addContextChildren",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.addContextChildren",
+"parameterOrder": [
+"context"
+],
+"parameters": {
+"context": {
+"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+context}:addContextChildren",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1AddContextChildrenResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "create": {
-"description": "Creates a reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
+"description": "Creates a Context associated with a MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.create",
+"id": "aiplatform.projects.locations.metadataStores.contexts.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"contextId": {
+"description": "The {context} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.)",
+"location": "query",
+"type": "string"
+},
 "parent": {
-"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/reasoningEngines",
+"path": "v1beta1/{+parent}/contexts",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+"$ref": "GoogleCloudAiplatformV1beta1Context"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Context"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"description": "Deletes a stored Context.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.delete",
+"id": "aiplatform.projects.locations.metadataStores.contexts.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"etag": {
+"description": "Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
+"location": "query",
+"type": "string"
+},
 "force": {
-"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
+"description": "The force deletion semantics is still undefined. Users should not use this field.",
 "location": "query",
 "type": "boolean"
 },
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The resource name of the Context to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20248,89 +20476,99 @@
 ]
 },
 "get": {
-"description": "Gets a reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"description": "Retrieves a specific Context.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.get",
+"id": "aiplatform.projects.locations.metadataStores.contexts.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The resource name of the Context to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+"$ref": "GoogleCloudAiplatformV1beta1Context"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists reasoning engines in a location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
+"description": "Lists Contexts on the MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.list",
+"id": "aiplatform.projects.locations.metadataStores.contexts.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: \"projects//locations//metadataStores//contexts/\" child_contexts: \"projects//locations//metadataStores//contexts/\" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/reasoningEngines",
+"path": "v1beta1/{+parent}/contexts",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListContextsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"description": "Updates a stored Context.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.reasoningEngines.patch",
+"id": "aiplatform.projects.locations.metadataStores.contexts.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"allowMissing": {
+"description": "If set to true, and the Context is not found, a new Context is created.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
-"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Immutable. The resource name of the Context.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. Mask specifying which fields to update.",
+"description": "Optional. A FieldMask indicating which fields should be updated.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -20338,435 +20576,11053 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+"$ref": "GoogleCloudAiplatformV1beta1Context"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1Context"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"query": {
-"description": "Queries using a reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query",
+"purge": {
+"description": "Purges Contexts.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts:purge",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.query",
+"id": "aiplatform.projects.locations.metadataStores.contexts.purge",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"parent": {
+"description": "Required. The metadata store to purge Contexts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:query",
+"path": "v1beta1/{+parent}/contexts:purge",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest"
+"$ref": "GoogleCloudAiplatformV1beta1PurgeContextsRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamQuery": {
-"description": "Streams queries using a reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.streamQuery",
+"queryContextLineageSubgraph": {
+"description": "Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:queryContextLineageSubgraph",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph",
 "parameterOrder": [
-"name"
+"context"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"context": {
+"description": "Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:streamQuery",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest"
-},
+"path": "v1beta1/{+context}:queryContextLineageSubgraph",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"a2a": {
-"resources": {
-"v1": {
-"methods": {
-"card": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card",
+"removeContextChildren": {
+"description": "Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}:removeContextChildren",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.removeContextChildren",
 "parameterOrder": [
-"name",
+"context"
+],
+"parameters": {
+"context": {
+"description": "Required. The resource name of the parent Context. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/contexts/{context}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+context}:removeContextChildren",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1RemoveContextChildrenResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.contexts.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"executions": {
+"methods": {
+"addExecutionEvents": {
+"description": "Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:addExecutionEvents",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.addExecutionEvents",
+"parameterOrder": [
+"execution"
+],
+"parameters": {
+"execution": {
+"description": "Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+execution}:addExecutionEvents",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1AddExecutionEventsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates an Execution associated with a MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"executionId": {
+"description": "The {execution} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/executions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Execution"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Execution"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes an Execution.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.executions.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"etag": {
+"description": "Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The resource name of the Execution to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Retrieves a specific Execution.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Execution to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Execution"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Executions in the MetadataStore.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The MetadataStore whose Executions should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/executions",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListExecutionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a stored Execution.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.metadataStores.executions.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"allowMissing": {
+"description": "If set to true, and the Execution is not found, a new Execution is created.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Output only. The resource name of the Execution.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. A FieldMask indicating which fields should be updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Execution"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Execution"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"purge": {
+"description": "Purges Executions.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions:purge",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.purge",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The metadata store to purge Executions from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/executions:purge",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PurgeExecutionsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"queryExecutionInputsAndOutputs": {
+"description": "Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}:queryExecutionInputsAndOutputs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs",
+"parameterOrder": [
+"execution"
+],
+"parameters": {
+"execution": {
+"description": "Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+execution}:queryExecutionInputsAndOutputs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1LineageSubgraph"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.executions.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"metadataSchemas": {
+"methods": {
+"create": {
+"description": "Creates a MetadataSchema.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"metadataSchemaId": {
+"description": "The {metadata_schema} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/metadataSchemas",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1MetadataSchema"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1MetadataSchema"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Retrieves a specific MetadataSchema.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas/{metadataSchemasId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/metadataSchemas/{metadataschema}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/metadataSchemas/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1MetadataSchema"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists MetadataSchemas.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/metadataSchemas",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.metadataSchemas.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "A query to filter available MetadataSchemas for matching results.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/metadataSchemas",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.metadataStores.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.metadataStores.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.metadataStores.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"migratableResources": {
+"methods": {
+"batchMigrate": {
+"description": "Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:batchMigrate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.migratableResources.batchMigrate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The location of the migrated resource will live in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/migratableResources:batchMigrate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchMigrateResourcesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"search": {
+"description": "Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources:search",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.migratableResources.search",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/migratableResources:search",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchMigratableResourcesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.migratableResources.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.migratableResources.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.migratableResources.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.migratableResources.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.migratableResources.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/migratableResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"modelDeploymentMonitoringJobs": {
+"methods": {
+"create": {
+"description": "Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a ModelDeploymentMonitoringJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a ModelDeploymentMonitoringJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists ModelDeploymentMonitoringJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/modelDeploymentMonitoringJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelDeploymentMonitoringJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a ModelDeploymentMonitoringJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Resource name of a ModelDeploymentMonitoringJob.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelDeploymentMonitoringJob"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"pause": {
+"description": "Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:pause",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:pause",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PauseModelDeploymentMonitoringJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"resume": {
+"description": "Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:resume",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:resume",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ResumeModelDeploymentMonitoringJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"searchModelDeploymentMonitoringStatsAnomalies": {
+"description": "Searches Model Monitoring Statistics generated within a given time window.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}:searchModelDeploymentMonitoringStatsAnomalies",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies",
+"parameterOrder": [
+"modelDeploymentMonitoringJob"
+],
+"parameters": {
+"modelDeploymentMonitoringJob": {
+"description": "Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project}/locations/{location}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchModelDeploymentMonitoringStatsAnomaliesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"modelMonitors": {
+"methods": {
+"create": {
+"description": "Creates a ModelMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelMonitors.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"modelMonitorId": {
+"description": "Optional. The ID to use for the Model Monitor, which will become the final component of the model monitor resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the ModelMonitor in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/modelMonitors",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelMonitor"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a ModelMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.modelMonitors.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "Optional. Force delete the model monitor with schedules.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the ModelMonitor resource to be deleted. Format: `projects/{project}/locations/{location}/modelMonitords/{model_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a ModelMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelMonitors.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ModelMonitor resource. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelMonitor"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists ModelMonitors in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelMonitors.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the ModelMonitors from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/modelMonitors",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelMonitorsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a ModelMonitor.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.modelMonitors.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Immutable. Resource name of the ModelMonitor. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. Mask specifying which fields to update.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelMonitor"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"searchModelMonitoringAlerts": {
+"description": "Returns the Model Monitoring alerts.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringAlerts",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringAlerts",
+"parameterOrder": [
+"modelMonitor"
+],
+"parameters": {
+"modelMonitor": {
+"description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+modelMonitor}:searchModelMonitoringAlerts",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringAlertsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"searchModelMonitoringStats": {
+"description": "Searches Model Monitoring Stats generated within a given time window.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}:searchModelMonitoringStats",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelMonitors.searchModelMonitoringStats",
+"parameterOrder": [
+"modelMonitor"
+],
+"parameters": {
+"modelMonitor": {
+"description": "Required. ModelMonitor resource name. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+modelMonitor}:searchModelMonitoringStats",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SearchModelMonitoringStatsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"modelMonitoringJobs": {
+"methods": {
+"create": {
+"description": "Creates a ModelMonitoringJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"modelMonitoringJobId": {
+"description": "Optional. The ID to use for the Model Monitoring Job, which will become the final component of the model monitoring job resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMoniitors/{model_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/modelMonitoringJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a ModelMonitoringJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the model monitoring job to delete. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a ModelMonitoringJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs/{modelMonitoringJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}/modelMonitoringJobs/{model_monitoring_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/modelMonitoringJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists ModelMonitoringJobs. Callers may choose to read across multiple Monitors as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of modelMonitor id in the parent. Format `projects/{project_id}/locations/{location}/moodelMonitors/-/modelMonitoringJobs`",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/modelMonitoringJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelMonitors.modelMonitoringJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent of the ModelMonitoringJob. Format: `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/modelMonitoringJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelMonitoringJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelMonitors.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.modelMonitors.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelMonitors.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.modelMonitors.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.modelMonitors.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/modelMonitors/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"models": {
+"methods": {
+"copy": {
+"description": "Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:copy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.copy",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location into which to copy the Model. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/models:copy",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CopyModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.models.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Model resource to be deleted. Format: `projects/{project}/locations/{location}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"deleteVersion": {
+"description": "Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:deleteVersion",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.models.deleteVersion",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:deleteVersion",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"export": {
+"description": "Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:export",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.export",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:export",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExportModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Model.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Model resource. Format: `projects/{project}/locations/{location}/models/{model}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the \"default\" version will be returned. The \"default\" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Model"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Models in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `baseModelName=\"text-bison\"`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the Models from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/models",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listCheckpoints": {
+"description": "Lists checkpoints of the specified model version.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listCheckpoints",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.listCheckpoints",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the model version to list checkpoints for. `projects/{project}/locations/{location}/models/{model}@{version}` Example: `projects/{project}/locations/{location}/models/{model}@2` or `projects/{project}/locations/{location}/models/{model}@golden` If no version ID or alias is specified, the latest version will be used.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:listCheckpoints",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelVersionCheckpointsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listVersions": {
+"description": "Lists versions of the specified model.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:listVersions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.listVersions",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `labels.myKey=\"myValue\"`",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The name of the model to list versions for.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.",
+"location": "query",
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:listVersions",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelVersionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"mergeVersionAliases": {
+"description": "Merges a set of aliases for a Model version.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:mergeVersionAliases",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.mergeVersionAliases",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project}/locations/{location}/models/{model}@1234`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:mergeVersionAliases",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Model"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a Model.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.models.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the Model.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Model"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Model"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:testIamPermissions",
+"response": {
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateExplanationDataset": {
+"description": "Incrementally update the dataset used for an examples model.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}:updateExplanationDataset",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.updateExplanationDataset",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The resource name of the Model to update. Format: `projects/{project}/locations/{location}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+model}:updateExplanationDataset",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UpdateExplanationDatasetRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"upload": {
+"description": "Uploads a Model artifact into Vertex AI.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models:upload",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.upload",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location into which to upload the Model. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/models:upload",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UploadModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"evaluations": {
+"methods": {
+"get": {
+"description": "Gets a ModelEvaluation.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ModelEvaluation resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Imports an externally generated ModelEvaluation.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.evaluations.import",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the parent model resource. Format: `projects/{project}/locations/{location}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/evaluations:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ImportModelEvaluationRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelEvaluation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists ModelEvaluations in a Model.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project}/locations/{location}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/evaluations",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.evaluations.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.models.evaluations.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.evaluations.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"slices": {
+"methods": {
+"batchImport": {
+"description": "Imports a list of externally generated EvaluatedAnnotations.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}:batchImport",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.evaluations.slices.batchImport",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}:batchImport",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchImportEvaluatedAnnotationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a ModelEvaluationSlice.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices/{slicesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.slices.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}/slices/{slice}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+/slices/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ModelEvaluationSlice"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists ModelEvaluationSlices in a ModelEvaluation.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/evaluations/{evaluationsId}/slices",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.evaluations.slices.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. * `slice.dimension` - for =.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project}/locations/{location}/models/{model}/evaluations/{evaluation}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/slices",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListModelEvaluationSlicesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.models.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.models.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/models/{modelsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.models.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/models/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"nasJobs": {
+"methods": {
+"cancel": {
+"description": "Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.nasJobs.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NasJob to cancel. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CancelNasJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a NasJob",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.nasJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the NasJob in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/nasJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1NasJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NasJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a NasJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.nasJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NasJob resource to be deleted. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a NasJob",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.nasJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NasJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"list": {
+"description": "Lists NasJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.nasJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/nasJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListNasJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"nasTrialDetails": {
+"methods": {
+"get": {
+"description": "Gets a NasTrialDetail.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails/{nasTrialDetailsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NasTrialDetail resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}/nasTrialDetails/{nas_trial_detail}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+/nasTrialDetails/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NasTrialDetail"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "List top NasTrialDetails of a NasJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/nasJobs/{nasJobsId}/nasTrialDetails",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.nasJobs.nasTrialDetails.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The name of the NasJob resource. Format: `projects/{project}/locations/{location}/nasJobs/{nas_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/nasJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/nasTrialDetails",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListNasTrialDetailsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookExecutionJobs": {
+"methods": {
+"create": {
+"description": "Creates a NotebookExecutionJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"notebookExecutionJobId": {
+"description": "Optional. User specified ID for the NotebookExecutionJob.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/notebookExecutionJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a NotebookExecutionJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookExecutionJob resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generateAccessToken": {
+"description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:generateAccessToken",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.generateAccessToken",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:generateAccessToken",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a NotebookExecutionJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookExecutionJob resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"view": {
+"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
+"enum": [
+"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
+"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
+"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
+],
+"enumDescriptions": [
+"When unspecified, the API defaults to the BASIC view.",
+"Includes all fields except for direct notebook inputs.",
+"Includes all fields."
+],
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists NotebookExecutionJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"view": {
+"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.",
+"enum": [
+"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED",
+"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC",
+"NOTEBOOK_EXECUTION_JOB_VIEW_FULL"
+],
+"enumDescriptions": [
+"When unspecified, the API defaults to the BASIC view.",
+"Includes all fields except for direct notebook inputs.",
+"Includes all fields."
+],
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/notebookExecutionJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListNotebookExecutionJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"reportEvent": {
+"description": "",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}:reportEvent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.reportEvent",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:reportEvent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookExecutionJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookRuntimeTemplates": {
+"methods": {
+"create": {
+"description": "Creates a NotebookRuntimeTemplate.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"notebookRuntimeTemplateId": {
+"description": "Optional. User specified ID for the notebook runtime template.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/notebookRuntimeTemplates",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a NotebookRuntimeTemplate.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a NotebookRuntimeTemplate.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project}/locations/{location}/notebookRuntimeTemplates/{notebook_runtime_template}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists NotebookRuntimeTemplates in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/notebookRuntimeTemplates",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimeTemplatesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a NotebookRuntimeTemplate.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The resource name of the NotebookRuntimeTemplate.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: \"${updated_filed}\"}` Updatable fields: * `encryption_spec.kms_key_name`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntimeTemplate"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setIamPolicy": {
+"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:setIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.setIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:setIamPolicy",
+"request": {
+"$ref": "GoogleIamV1SetIamPolicyRequest"
+},
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}:testIamPermissions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"permissions": {
+"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:testIamPermissions",
+"response": {
+"$ref": "GoogleIamV1TestIamPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"notebookRuntimes": {
+"methods": {
+"assign": {
+"description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.assign",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/notebookRuntimes:assign",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a NotebookRuntime.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookRuntimes.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generateAccessToken": {
+"description": "Internal only: Called from Compute Engine instance to obtain EUC for owner Anonymous access: authenticates caller using VM identity JWT. Design doc: go/colab-on-vertex-euc-dd",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:generateAccessToken",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.generateAccessToken",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:generateAccessToken",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateAccessTokenResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a NotebookRuntime.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimes.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1NotebookRuntime"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists NotebookRuntimes in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimes.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/notebookRuntimes",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListNotebookRuntimesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"reportEvent": {
+"description": "",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:reportEvent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.reportEvent",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:reportEvent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"start": {
+"description": "Starts a NotebookRuntime.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.start",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:start",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"stop": {
+"description": "Stops a NotebookRuntime.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.stop",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:stop",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StopNotebookRuntimeRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"upgrade": {
+"description": "Upgrades a NotebookRuntime.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.upgrade",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:upgrade",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1UpgradeNotebookRuntimeRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.notebookRuntimes.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"persistentResources": {
+"methods": {
+"create": {
+"description": "Creates a PersistentResource.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"persistentResourceId": {
+"description": "Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$/`.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/persistentResources",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PersistentResource"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a PersistentResource.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.persistentResources.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PersistentResource to be deleted. Format: `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a PersistentResource.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.persistentResources.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1PersistentResource"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists PersistentResources in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.persistentResources.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/persistentResources",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListPersistentResourcesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a PersistentResource.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.persistentResources.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Immutable. Resource name of a PersistentResource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. Specify the fields to be overwritten in the PersistentResource by the update method.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PersistentResource"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"reboot": {
+"description": "Reboots a PersistentResource.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}:reboot",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.reboot",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number}/locations/{location_id}/persistentResources/{persistent_resource_id}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:reboot",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RebootPersistentResourceRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.persistentResources.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.persistentResources.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.persistentResources.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.persistentResources.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/persistentResources/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"pipelineJobs": {
+"methods": {
+"batchCancel": {
+"description": "Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchCancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.batchCancel",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/pipelineJobs:batchCancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchCancelPipelineJobsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"batchDelete": {
+"description": "Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs:batchDelete",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.batchDelete",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the PipelineJobs' parent resource. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/pipelineJobs:batchDelete",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchDeletePipelineJobsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"cancel": {
+"description": "Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PipelineJob to cancel. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CancelPipelineJobRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a PipelineJob. A PipelineJob will run immediately when created.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pipelineJobId": {
+"description": "The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/pipelineJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PipelineJob"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1PipelineJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a PipelineJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.pipelineJobs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a PipelineJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PipelineJob resource. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1PipelineJob"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists PipelineJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\\\"*step*\\\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name=\"test\" AND create_time>\"2020-05-18T13:30:00Z\"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time>\"2021-05-18T00:00:00Z\" OR update_time>\"2020-05-18T00:00:00Z\"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = \"prod\"` PipelineJobs with label \"env\" set to \"prod\".",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided e.g. \"create_time desc, end_time\", \"end_time, start_time, update_time\" For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/pipelineJobs",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListPipelineJobsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.pipelineJobs.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pipelineJobs/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"publishers": {
+"resources": {
+"models": {
+"methods": {
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:computeTokens",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.computeTokens",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:computeTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:countTokens",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.countTokens",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:countTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"embedContent": {
+"description": "Embed content with multimodal inputs.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:embedContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.embedContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+model}:embedContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1EmbedContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"export": {
+"description": "Exports a publisher model to a user provided Google Cloud Storage bucket.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:export",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.export",
+"parameterOrder": [
+"parent",
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}@{version_id}`, or `publishers/hf-{hugging-face-author}/models/{hugging-face-model-name}@001`",
+"location": "path",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+},
+"parent": {
+"description": "Required. The Location to export the model weights from Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/{+name}:export",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExportPublisherModelRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.fetchPredictOperation",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"fetchPublisherModelConfig": {
+"description": "Fetches the configs of publisher models.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:fetchPublisherModelConfig",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.publishers.models.fetchPublisherModelConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:fetchPublisherModelConfig",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:generateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.generateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+model}:generateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"getIamPolicy": {
+"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:getIamPolicy",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.getIamPolicy",
+"parameterOrder": [
+"resource"
+],
+"parameters": {
+"options.requestedPolicyVersion": {
+"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"resource": {
+"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+resource}:getIamPolicy",
+"response": {
+"$ref": "GoogleIamV1Policy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.predict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:predict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.predictLongRunning",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:predictLongRunning",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"rawPredict": {
+"description": "Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:rawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.rawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:rawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RawPredictRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"serverStreamingPredict": {
+"description": "Perform a server-side streaming online prediction request for Vertex LLM streaming.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:serverStreamingPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.serverStreamingPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:serverStreamingPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamingPredictResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"setPublisherModelConfig": {
+"description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:setPublisherModelConfig",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.setPublisherModelConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:setPublisherModelConfig",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.streamGenerateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+model}:streamGenerateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"streamRawPredict": {
+"description": "Perform a streaming online prediction with an arbitrary HTTP payload.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/models/{modelsId}:streamRawPredict",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.publishers.models.streamRawPredict",
+"parameterOrder": [
+"endpoint"
+],
+"parameters": {
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+endpoint}:streamRawPredict",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamRawPredictRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+}
+}
+}
+}
+},
+"ragCorpora": {
+"methods": {
+"create": {
+"description": "Creates a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/ragCorpora",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RagCorpus"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.ragCorpora.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the RagCorpus resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1RagCorpus"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists RagCorpora in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/ragCorpora",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListRagCorporaResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.ragCorpora.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. The resource name of the RagCorpus.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RagCorpus"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.ragCorpora.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"ragFiles": {
+"methods": {
+"delete": {
+"description": "Deletes a RagFile.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"forceDelete": {
+"description": "Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the RagFile resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a RagFile.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the RagFile resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1RagFile"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Import files from Google Cloud Storage or Google Drive into a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles:import",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.import",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/ragFiles:import",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ImportRagFilesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists RagFiles in a RagCorpus.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/ragFiles",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListRagFilesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+}
+},
+"ragEngineConfig": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.ragEngineConfig.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"reasoningEngines": {
+"methods": {
+"create": {
+"description": "Creates a reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/reasoningEngines",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists reasoning engines in a location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/reasoningEngines",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.reasoningEngines.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. Mask specifying which fields to update.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"query": {
+"description": "Queries using a reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:query",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.query",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:query",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"streamQuery": {
+"description": "Streams queries using a reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}:streamQuery",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.streamQuery",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:streamQuery",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"a2a": {
+"resources": {
+"v1": {
+"methods": {
+"card": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"location": "path",
+"pattern": "^v1/card$",
+"required": true,
+"type": "string"
+},
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"response": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"message": {
+"methods": {
+"send": {
+"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
+"location": "path",
+"pattern": "^v1/message$",
+"required": true,
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send",
+"request": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"response": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"stream": {
+"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.",
+"location": "path",
+"pattern": "^v1/message$",
+"required": true,
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream",
+"request": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"tasks": {
+"methods": {
+"a2aGetReasoningEngine": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"response": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"cancel": {
+"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel",
+"request": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"response": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"pushNotificationConfigs": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$",
+"required": true,
+"type": "string"
+},
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"response": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"subscribe": {
+"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe",
+"parameterOrder": [
+"name",
+"a2aEndpoint"
+],
+"parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe",
+"response": {
+"$ref": "GoogleApiHttpBody"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"pushNotificationConfigs": {
+"methods": {
+"a2aGetReasoningEngine": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine",
+"parameterOrder": [
+"name",
 "a2aEndpoint"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"response": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+}
+}
+}
+},
+"examples": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"memories": {
+"methods": {
+"create": {
+"description": "Create a Memory.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/memories",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Memory"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Delete a Memory.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"generate": {
+"description": "Generate memories.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.generate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/memories:generate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Get a Memory.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Memory"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "List Memories.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/memories",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Update a Memory.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Memory"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"retrieve": {
+"description": "Retrieve memories.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.retrieve",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/memories:retrieve",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"rollback": {
+"description": "Rollback Memory to a specific revision.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.rollback",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:rollback",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"revisions": {
+"methods": {
+"get": {
+"description": "Get a Memory Revision.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "List Memory Revisions for a Memory.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.memories.revisions.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/revisions",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"sandboxEnvironments": {
+"methods": {
+"create": {
+"description": "Creates a SandboxEnvironment in a given reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/sandboxEnvironments",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes the specific SandboxEnvironment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"execute": {
+"description": "Executes using a sandbox environment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:execute",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of the specific SandboxEnvironment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists SandboxEnvironments in a given reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/sandboxEnvironments",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"sessions": {
+"methods": {
+"appendEvent": {
+"description": "Appends an event to a given session.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:appendEvent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SessionEvent"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a new Session.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/sessions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Session"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes details of the specific Session.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets details of the specific Session.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Session"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Sessions in a given reasoning engine.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` Example: `display_name=\"abc\"`, `user_id=\"123\"`.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/sessions",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates the specific Session.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Session"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Session"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"events": {
+"methods": {
+"list": {
+"description": "Lists Events in a given session.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/events",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+}
+},
+"schedules": {
+"methods": {
+"create": {
+"description": "Creates a Schedule.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/schedules",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Schedule.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.schedules.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Schedule.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.schedules.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Schedules in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.schedules.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size. Default to 100 if not specified.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/schedules",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.schedules.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Immutable. The resource name of the Schedule.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"pause": {
+"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.pause",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:pause",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"resume": {
+"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.resume",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:resume",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest"
+},
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.schedules.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.schedules.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.schedules.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.schedules.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"solvers": {
+"resources": {
+"operations": {
+"methods": {
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.solvers.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.solvers.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.solvers.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"specialistPools": {
+"methods": {
+"create": {
+"description": "Creates a SpecialistPool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.specialistPools.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/specialistPools",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a SpecialistPool as well as all Specialists in the pool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.specialistPools.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"force": {
+"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)",
+"location": "query",
+"type": "boolean"
+},
+"name": {
+"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a SpecialistPool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.specialistPools.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists SpecialistPools in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.specialistPools.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read. FieldMask represents a set of",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/specialistPools",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a SpecialistPool.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.specialistPools.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the SpecialistPool.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. The update mask applies to the resource.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.specialistPools.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.specialistPools.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.specialistPools.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.specialistPools.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.specialistPools.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"studies": {
+"methods": {
+"create": {
+"description": "Creates a Study. A resource name will be generated after creation of the Study.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/studies",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Study"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Study"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Study.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.studies.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Study by name.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Study"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists all the studies in a region for an associated project.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/studies",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"lookup": {
+"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.lookup",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/studies:lookup",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Study"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.studies.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"trials": {
+"methods": {
+"addTrialMeasurement": {
+"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement",
+"parameterOrder": [
+"trialName"
+],
+"parameters": {
+"trialName": {
+"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+trialName}:addTrialMeasurement",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Trial"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"checkTrialEarlyStoppingState": {
+"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState",
+"parameterOrder": [
+"trialName"
+],
+"parameters": {
+"trialName": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"complete": {
+"description": "Marks a Trial as complete.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.complete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:complete",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Trial"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Adds a user provided Trial to a Study.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/trials",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Trial"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Trial"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Trial.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.studies.trials.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Trial.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.trials.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Trial"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists the Trials associated with a Study.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.trials.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/trials",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listOptimalTrials": {
+"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The name of the Study that the optimal Trial belongs to.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/trials:listOptimalTrials",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"stop": {
+"description": "Stops a Trial.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.stop",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:stop",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Trial"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"suggest": {
+"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.suggest",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/trials:suggest",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.studies.trials.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.trials.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.studies.trials.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.studies.trials.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+}
+},
+"tensorboards": {
+"methods": {
+"batchRead": {
+"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.batchRead",
+"parameterOrder": [
+"tensorboard"
+],
+"parameters": {
+"tensorboard": {
+"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+},
+"timeSeries": {
+"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"location": "query",
+"repeated": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+tensorboard}:batchRead",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a Tensorboard.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/tensorboards",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Tensorboard"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a Tensorboard.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tensorboards.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Tensorboard.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1Tensorboard"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists Tensorboards in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the Tensorboards that match the filter expression.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Field to use to sort the list.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/tensorboards",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a Tensorboard.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.tensorboards.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Tensorboard"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"readSize": {
+"description": "Returns the storage size for a given TensorBoard instance.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.readSize",
+"parameterOrder": [
+"tensorboard"
+],
+"parameters": {
+"tensorboard": {
+"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+tensorboard}:readSize",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"readUsage": {
+"description": "Returns a list of monthly active users for a given TensorBoard instance.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.readUsage",
+"parameterOrder": [
+"tensorboard"
+],
+"parameters": {
+"tensorboard": {
+"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+tensorboard}:readUsage",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
+"resources": {
+"experiments": {
+"methods": {
+"batchCreate": {
+"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}:batchCreate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"create": {
+"description": "Creates a TensorboardExperiment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"required": true,
+"type": "string"
+},
+"tensorboardExperimentId": {
+"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/experiments",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a TensorboardExperiment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tensorboards.experiments.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a TensorboardExperiment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^v1/card$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists TensorboardExperiments in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the TensorboardExperiments that match the filter expression.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"orderBy": {
+"description": "Field to use to sort the list.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+parent}/experiments",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"message": {
-"methods": {
-"send": {
-"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send",
+"patch": {
+"description": "Updates a TensorboardExperiment.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.tensorboards.experiments.patch",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
+"name": {
+"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^v1/message$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
-"required": true,
+"updateMask": {
+"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"format": "google-fieldmask",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send",
+"path": "v1beta1/{+name}",
 "request": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
 },
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"stream": {
-"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream",
+"write": {
+"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream",
+"id": "aiplatform.projects.locations.tensorboards.experiments.write",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"tensorboardExperiment"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.",
+"tensorboardExperiment": {
+"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^v1/message$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
+}
+},
+"path": "v1beta1/{+tensorboardExperiment}:write",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
 },
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream",
-"request": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
 },
-"type": "object"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"tasks": {
-"methods": {
-"a2aGetReasoningEngine": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^v1/tasks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"cancel": {
-"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel",
+"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^v1/tasks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:wait",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"runs": {
+"methods": {
+"batchCreate": {
+"description": "Batch create TensorboardRuns.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel",
+"path": "v1beta1/{+parent}/runs:batchCreate",
 "request": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest"
 },
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"pushNotificationConfigs": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs",
+"create": {
+"description": "Creates a TensorboardRun.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"parent"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"parent": {
+"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
 },
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"tensorboardRunId": {
+"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
 "location": "query",
 "type": "string"
+}
+},
+"path": "v1beta1/{+parent}/runs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
+"delete": {
+"description": "Deletes a TensorboardRun.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+name}",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"subscribe": {
-"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe",
+"get": {
+"description": "Gets a TensorboardRun.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.",
+"name": {
+"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^v1/tasks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists TensorboardRuns in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Lists the TensorboardRuns that match the filter expression.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Field to use to sort the list.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe",
+"path": "v1beta1/{+parent}/runs",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"pushNotificationConfigs": {
-"methods": {
-"a2aGetReasoningEngine": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine",
+"patch": {
+"description": "Updates a TensorboardRun.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"name": {
+"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 },
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"updateMask": {
+"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
+}
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"write": {
+"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write",
+"parameterOrder": [
+"tensorboardRun"
+],
+"parameters": {
+"tensorboardRun": {
+"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
-"response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
+"path": "v1beta1/{+tensorboardRun}:write",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest"
 },
-"type": "object"
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
-}
-}
-}
-}
 },
-"examples": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -20774,7 +31630,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20789,9 +31645,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -20799,7 +31655,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20814,9 +31670,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -20824,7 +31680,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20837,11 +31693,57 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.examples.operations.wait",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -20849,7 +31751,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -20869,52 +31771,55 @@
 ]
 }
 }
-}
-}
 },
-"memories": {
+"timeSeries": {
 "methods": {
 "create": {
-"description": "Create a Memory.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories",
+"description": "Creates a TensorboardTimeSeries.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.create",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"tensorboardTimeSeriesId": {
+"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/memories",
+"path": "v1beta1/{+parent}/timeSeries",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Memory"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Delete a Memory.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"description": "Deletes a TensorboardTimeSeries.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -20927,123 +31832,129 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generate": {
-"description": "Generate memories.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:generate",
+"exportTensorboardTimeSeries": {
+"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.generate",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries",
 "parameterOrder": [
-"parent"
+"tensorboardTimeSeries"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"tensorboardTimeSeries": {
+"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/memories:generate",
+"path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Get a Memory.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"description": "Gets a TensorboardTimeSeries.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Memory"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "List Memories.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories",
+"description": "Lists TensorboardTimeSeries in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)",
+"description": "Lists the TensorboardTimeSeries that match the filter expression.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`",
+"description": "Field to use to sort the list.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/memories",
+"path": "v1beta1/{+parent}/timeSeries",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Update a Memory.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"description": "Updates a TensorboardTimeSeries.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.patch",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"description": "Output only. Name of the TensorboardTimeSeries.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`",
+"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -21051,38 +31962,77 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Memory"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"retrieve": {
-"description": "Retrieve memories.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:retrieve",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.retrieve",
+"read": {
+"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read",
 "parameterOrder": [
-"parent"
+"tensorboardTimeSeries"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"filter": {
+"description": "Reads the TensorboardTimeSeries' data that match the filter expression.",
+"location": "query",
+"type": "string"
+},
+"maxDataPoints": {
+"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"tensorboardTimeSeries": {
+"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/memories:retrieve",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest"
+"path": "v1beta1/{+tensorboardTimeSeries}:read",
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"readBlobData": {
+"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData",
+"httpMethod": "GET",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData",
+"parameterOrder": [
+"timeSeries"
+],
+"parameters": {
+"blobIds": {
+"description": "IDs of the blobs to read.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"timeSeries": {
+"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+timeSeries}:readBlobData",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -21094,9 +32044,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -21104,7 +32054,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21119,9 +32069,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -21129,7 +32079,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21144,9 +32094,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -21154,7 +32104,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21169,9 +32119,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -21184,7 +32134,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -21215,9 +32165,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.memories.operations.wait",
+"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -21225,7 +32175,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -21247,14 +32197,18 @@
 }
 }
 }
+}
+}
+}
+}
 },
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.cancel",
+"id": "aiplatform.projects.locations.tensorboards.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -21262,7 +32216,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21277,9 +32231,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.delete",
+"id": "aiplatform.projects.locations.tensorboards.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -21287,7 +32241,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21302,9 +32256,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.get",
+"id": "aiplatform.projects.locations.tensorboards.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -21312,7 +32266,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21327,9 +32281,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.list",
+"id": "aiplatform.projects.locations.tensorboards.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -21342,7 +32296,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -21373,9 +32327,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.operations.wait",
+"id": "aiplatform.projects.locations.tensorboards.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -21383,7 +32337,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -21403,151 +32357,159 @@
 ]
 }
 }
+}
+}
 },
-"sandboxEnvironments": {
+"trainingPipelines": {
 "methods": {
-"create": {
-"description": "Creates a SandboxEnvironment in a given reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments",
+"cancel": {
+"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create",
+"id": "aiplatform.projects.locations.trainingPipelines.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.",
+"name": {
+"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/sandboxEnvironments",
+"path": "v1beta1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment"
+"$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes the specific SandboxEnvironment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete",
+"create": {
+"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.trainingPipelines.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
+"parent": {
+"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/trainingPipelines",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"execute": {
-"description": "Executes using a sandbox environment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute",
+"delete": {
+"description": "Deletes a TrainingPipeline.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.trainingPipelines.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
+"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:execute",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets details of the specific SandboxEnvironment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}",
+"description": "Gets a TrainingPipeline.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get",
+"id": "aiplatform.projects.locations.trainingPipelines.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
+"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment"
+"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists SandboxEnvironments in a given reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments",
+"description": "Lists TrainingPipelines in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list",
+"id": "aiplatform.projects.locations.trainingPipelines.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.",
+"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"readMask": {
+"description": "Mask specifying which fields to read.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/sandboxEnvironments",
+"path": "v1beta1/{+parent}/trainingPipelines",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -21559,9 +32521,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -21569,7 +32531,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21584,9 +32546,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -21594,7 +32556,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21609,9 +32571,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -21619,7 +32581,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -21634,9 +32596,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.list",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -21649,7 +32611,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -21680,9 +32642,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait",
+"id": "aiplatform.projects.locations.trainingPipelines.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -21690,7 +32652,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -21713,626 +32675,681 @@
 }
 }
 },
-"sessions": {
+"tuningJobs": {
 "methods": {
-"appendEvent": {
-"description": "Appends an event to a given session.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent",
+"cancel": {
+"description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.appendEvent",
+"id": "aiplatform.projects.locations.tuningJobs.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:appendEvent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SessionEvent"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a new Session.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/sessions",
+"path": "v1beta1/{+name}:cancel",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
+"$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes details of the specific Session.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.delete",
+"create": {
+"description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tuningJobs.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"parent": {
+"description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/tuningJobs",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1TuningJob"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1TuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets details of the specific Session.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"description": "Gets a TuningJob.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.get",
+"id": "aiplatform.projects.locations.tuningJobs.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
+"$ref": "GoogleCloudAiplatformV1beta1TuningJob"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Sessions in a given reasoning engine.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions",
+"description": "Lists TuningJobs in a Location.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.list",
+"id": "aiplatform.projects.locations.tuningJobs.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.",
+"description": "Optional. The standard list filter.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.",
+"description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/sessions",
+"path": "v1beta1/{+parent}/tuningJobs",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the specific Session.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.patch",
+"optimizePrompt": {
+"description": "Optimizes a prompt.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tuningJobs.optimizePrompt",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.",
+"parent": {
+"description": "Required. The resource name of the Location to optimize the prompt in. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/tuningJobs:optimizePrompt",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
+"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
+"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"events": {
-"methods": {
-"list": {
-"description": "Lists Events in a given session.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.events.list",
+"rebaseTunedModel": {
+"description": "Rebase a TunedModel.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"filter": {
-"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.",
-"location": "query",
-"type": "string"
-},
 "parent": {
-"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/events",
+"path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
 },
+"resources": {
 "operations": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.projects.locations.tuningJobs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to be cancelled.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:cancel",
+"path": "v1beta1/{+name}",
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
+}
+}
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.delete",
+"modelGardenEula": {
+"methods": {
+"accept": {
+"description": "Accepts the EULA acceptance status of a publisher model.",
+"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept",
+"httpMethod": "POST",
+"id": "aiplatform.projects.modelGardenEula.accept",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"parent": {
+"description": "Required. The project requesting access for named model. The format is `projects/{project}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/modelGardenEula:accept",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.get",
+"check": {
+"description": "Checks the EULA acceptance status of a publisher model.",
+"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check",
+"httpMethod": "POST",
+"id": "aiplatform.projects.modelGardenEula.check",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"parent": {
+"description": "Required. The project requesting access for named model. The format is `projects/{project}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/modelGardenEula:check",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.list",
+"publishers": {
+"resources": {
+"models": {
+"methods": {
+"enableModel": {
+"description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).",
+"flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel",
+"httpMethod": "POST",
+"id": "aiplatform.projects.publishers.models.enableModel",
 "parameterOrder": [
+"parent",
 "name"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "The name of the operation's parent resource.",
+"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
+"parent": {
+"description": "Required. The project requesting access for named model. Format: `projects/{project}`",
+"location": "path",
+"pattern": "^projects/[^/]+$",
+"required": true,
 "type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/{+parent}/{+name}:enableModel",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
+}
+}
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait",
+"publishers": {
+"resources": {
+"models": {
+"methods": {
+"computeTokens": {
+"description": "Return a list of tokens based on the input text.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.reasoningEngines.sessions.operations.wait",
+"id": "aiplatform.publishers.models.computeTokens",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+endpoint}:computeTokens",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
-}
-}
 },
-"schedules": {
-"methods": {
-"create": {
-"description": "Creates a Schedule.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules",
+"countTokens": {
+"description": "Perform a token counting.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.create",
+"id": "aiplatform.publishers.models.countTokens",
 "parameterOrder": [
-"parent"
+"endpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the Schedule in. Format: `projects/{project}/locations/{location}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/schedules",
+"path": "v1beta1/{+endpoint}:countTokens",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"delete": {
-"description": "Deletes a Schedule.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.schedules.delete",
+"fetchPredictOperation": {
+"description": "Fetch an asynchronous online prediction operation.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
+"httpMethod": "POST",
+"id": "aiplatform.publishers.models.fetchPredictOperation",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Schedule resource to be deleted. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:fetchPredictOperation",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
+]
+},
+"generateContent": {
+"description": "Generate content with multimodal inputs.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent",
+"httpMethod": "POST",
+"id": "aiplatform.publishers.models.generateContent",
+"parameterOrder": [
+"model"
+],
+"parameters": {
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"location": "path",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+model}:generateContent",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+},
+"response": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
 "get": {
-"description": "Gets a Schedule.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
+"description": "Gets a Model Garden publisher model.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.get",
+"id": "aiplatform.publishers.models.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
+"huggingFaceToken": {
+"description": "Optional. Token used to access Hugging Face gated models.",
+"location": "query",
+"type": "string"
+},
+"includeEquivalentModelGardenModelDeploymentConfigs": {
+"description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.",
+"location": "query",
+"type": "boolean"
+},
+"isHuggingFaceModel": {
+"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.",
+"location": "query",
+"type": "boolean"
+},
+"languageCode": {
+"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The name of the Schedule resource. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
+},
+"view": {
+"description": "Optional. PublisherModel view specifying which fields to read.",
+"enum": [
+"PUBLISHER_MODEL_VIEW_UNSPECIFIED",
+"PUBLISHER_MODEL_VIEW_BASIC",
+"PUBLISHER_MODEL_VIEW_FULL",
+"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
+],
+"enumDescriptions": [
+"The default / unset value. The API will default to the BASIC view.",
+"Include basic metadata about the publisher model, but not the full contents.",
+"Include everything.",
+"Include: VersionId, ModelVersionExternalName, and SupportedActions."
+],
+"location": "query",
+"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+"$ref": "GoogleCloudAiplatformV1beta1PublisherModel"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Schedules in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules",
+"description": "Lists publisher models in Model Garden.",
+"flatPath": "v1beta1/publishers/{publishersId}/models",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.list",
+"id": "aiplatform.publishers.models.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `>`, `<=`, `>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state=\"ACTIVE\" AND display_name:\"my_schedule_*\"` * `NOT display_name=\"my_schedule\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `end_time>\"2021-05-18T00:00:00Z\" OR NOT end_time:*` * `create_pipeline_job_request:*`",
+"description": "Optional. The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"languageCode": {
+"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).",
 "location": "query",
 "type": "string"
 },
+"listAllVersions": {
+"description": "Optional. List all publisher model versions if the flag is set to true.",
+"location": "query",
+"type": "boolean"
+},
 "orderBy": {
-"description": "A comma-separated list of fields to order by. The default sort order is in ascending order. Use \"desc\" after a field name for descending. You can have multiple order_by fields provided. For example, using \"create_time desc, end_time\" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time`",
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The standard list page size. Default to 100 if not specified.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call.",
+"description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list the Schedules from. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^publishers/[^/]+$",
 "required": true,
 "type": "string"
+},
+"view": {
+"description": "Optional. PublisherModel view specifying which fields to read.",
+"enum": [
+"PUBLISHER_MODEL_VIEW_UNSPECIFIED",
+"PUBLISHER_MODEL_VIEW_BASIC",
+"PUBLISHER_MODEL_VIEW_FULL",
+"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
+],
+"enumDescriptions": [
+"The default / unset value. The API will default to the BASIC view.",
+"Include basic metadata about the publisher model, but not the full contents.",
+"Include everything.",
+"Include: VersionId, ModelVersionExternalName, and SupportedActions."
+],
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/schedules",
+"path": "v1beta1/{+parent}/models",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListSchedulesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.schedules.patch",
+"predict": {
+"description": "Perform an online prediction.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict",
+"httpMethod": "POST",
+"id": "aiplatform.publishers.models.predict",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Immutable. The resource name of the Schedule.",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+endpoint}:predict",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Schedule"
+"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"pause": {
-"description": "Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:pause",
+"predictLongRunning": {
+"description": "",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.pause",
+"id": "aiplatform.publishers.models.predictLongRunning",
 "parameterOrder": [
-"name"
+"endpoint"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Schedule resource to be paused. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"endpoint": {
+"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:pause",
+"path": "v1beta1/{+endpoint}:predictLongRunning",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1PauseScheduleRequest"
+"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
 },
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 },
-"resume": {
-"description": "Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}:resume",
+"streamGenerateContent": {
+"description": "Generate content with multimodal inputs with streaming support.",
+"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.resume",
+"id": "aiplatform.publishers.models.streamGenerateContent",
 "parameterOrder": [
-"name"
+"model"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Schedule resource to be resumed. Format: `projects/{project}/locations/{location}/schedules/{schedule}`",
+"model": {
+"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^publishers/[^/]+/models/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:resume",
+"path": "v1beta1/{+model}:streamGenerateContent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
 },
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloud-platform.read-only"
 ]
 }
+}
+}
+}
 },
+"ragCorpora": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.operations.cancel",
+"id": "aiplatform.ragCorpora.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -22340,7 +33357,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22355,9 +33372,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.schedules.operations.delete",
+"id": "aiplatform.ragCorpora.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -22365,7 +33382,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22380,9 +33397,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.operations.get",
+"id": "aiplatform.ragCorpora.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -22390,7 +33407,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22405,9 +33422,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.schedules.operations.list",
+"id": "aiplatform.ragCorpora.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -22420,7 +33437,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+$",
+"pattern": "^ragCorpora/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -22451,9 +33468,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/schedules/{schedulesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.schedules.operations.wait",
+"id": "aiplatform.ragCorpora.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -22461,7 +33478,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/schedules/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -22481,18 +33498,41 @@
 ]
 }
 }
-}
-}
 },
-"solvers": {
+"ragFiles": {
 "resources": {
 "operations": {
 "methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.ragCorpora.ragFiles.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.solvers.operations.delete",
+"id": "aiplatform.ragCorpora.ragFiles.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -22500,7 +33540,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22515,9 +33555,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations/{operationsId}",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.solvers.operations.get",
+"id": "aiplatform.ragCorpora.ragFiles.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -22525,7 +33565,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+/operations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22540,9 +33580,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/solvers/{solversId}/operations",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.solvers.operations.list",
+"id": "aiplatform.ragCorpora.ragFiles.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -22555,7 +33595,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/solvers/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -22583,181 +33623,53 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"specialistPools": {
-"methods": {
-"create": {
-"description": "Creates a SpecialistPool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/ragCorpora/{ragCorporaId}/ragFiles/{ragFilesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.specialistPools.create",
+"id": "aiplatform.ragCorpora.ragFiles.operations.wait",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The parent Project name for the new SpecialistPool. The form is `projects/{project}/locations/{location}`.",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^ragCorpora/[^/]+/ragFiles/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+parent}/specialistPools",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 },
-"delete": {
-"description": "Deletes a SpecialistPool as well as all Specialists in the pool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.specialistPools.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"force": {
-"description": "If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.)",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
-"type": "boolean"
-},
-"name": {
-"description": "Required. The resource name of the SpecialistPool to delete. Format: `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
-"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"get": {
-"description": "Gets a SpecialistPool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the SpecialistPool resource. The form is `projects/{project}/locations/{location}/specialistPools/{specialist_pool}`.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists SpecialistPools in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The name of the SpecialistPool's parent resource. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read. FieldMask represents a set of",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1beta1/{+parent}/specialistPools",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListSpecialistPoolsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates a SpecialistPool.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.specialistPools.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The resource name of the SpecialistPool.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. The update mask applies to the resource.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
-},
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SpecialistPool"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+}
+}
 }
 },
+"ragEngineConfig": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.specialistPools.operations.cancel",
+"id": "aiplatform.ragEngineConfig.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -22765,7 +33677,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22780,9 +33692,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.specialistPools.operations.delete",
+"id": "aiplatform.ragEngineConfig.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -22790,7 +33702,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22805,9 +33717,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.operations.get",
+"id": "aiplatform.ragEngineConfig.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -22815,7 +33727,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -22830,9 +33742,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations",
+"flatPath": "v1beta1/ragEngineConfig/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.specialistPools.operations.list",
+"id": "aiplatform.ragEngineConfig.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -22845,7 +33757,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+$",
+"pattern": "^ragEngineConfig$",
 "required": true,
 "type": "string"
 },
@@ -22876,9 +33788,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/ragEngineConfig/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.specialistPools.operations.wait",
+"id": "aiplatform.ragEngineConfig.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -22886,7 +33798,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/specialistPools/[^/]+/operations/[^/]+$",
+"pattern": "^ragEngineConfig/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -22909,601 +33821,578 @@
 }
 }
 },
-"studies": {
+"reasoningEngines": {
 "methods": {
 "create": {
-"description": "Creates a Study. A resource name will be generated after creation of the Study.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies",
+"description": "Creates a reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.create",
-"parameterOrder": [
-"parent"
-],
+"id": "aiplatform.reasoningEngines.create",
+"parameterOrder": [],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
+"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/studies",
+"path": "v1beta1/reasoningEngines",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Study"
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Study"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a Study.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
+"description": "Deletes a reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the Study resource to be deleted. Format: `projects/{project}/locations/{location}/studies/{study}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets a Study by name.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.get",
+"id": "aiplatform.reasoningEngines.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the Study resource. Format: `projects/{project}/locations/{location}/studies/{study}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1Study"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists all the studies in a region for an associated project.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"pageSize": {
-"description": "Optional. The maximum number of studies to return per \"page\" of results. If unspecified, service will pick an appropriate default.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
+"force": {
+"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
 "location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to list the Study from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/studies",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListStudiesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"lookup": {
-"description": "Looks a study up using the user-defined display_name field instead of the fully qualified resource name.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies:lookup",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.lookup",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to get the Study from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/studies:lookup",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1LookupStudyRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1Study"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
-"resources": {
-"operations": {
-"methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"type": "boolean"
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.operations.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
 "name": {
-"description": "The name of the operation resource to be deleted.",
+"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}",
+"description": "Gets a reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.operations.get",
+"id": "aiplatform.reasoningEngines.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource.",
+"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations",
+"description": "Lists reasoning engines in a location.",
+"flatPath": "v1beta1/reasoningEngines",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.operations.list",
-"parameterOrder": [
-"name"
-],
+"id": "aiplatform.reasoningEngines.list",
+"parameterOrder": [],
 "parameters": {
 "filter": {
-"description": "The standard list filter.",
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
-"required": true,
-"type": "string"
-},
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"parent": {
+"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1beta1/{+name}/operations",
+"path": "v1beta1/reasoningEngines",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.operations.wait",
+"patch": {
+"description": "Updates a reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}",
+"httpMethod": "PATCH",
+"id": "aiplatform.reasoningEngines.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "The name of the operation resource to wait on.",
+"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 },
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
+"updateMask": {
+"description": "Optional. Mask specifying which fields to update.",
+"format": "google-fieldmask",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:wait",
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"trials": {
-"methods": {
-"addTrialMeasurement": {
-"description": "Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:addTrialMeasurement",
+"query": {
+"description": "Queries using a reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.addTrialMeasurement",
+"id": "aiplatform.reasoningEngines.query",
 "parameterOrder": [
-"trialName"
+"name"
 ],
 "parameters": {
-"trialName": {
-"description": "Required. The name of the trial to add measurement. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+trialName}:addTrialMeasurement",
+"path": "v1beta1/{+name}:query",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1AddTrialMeasurementRequest"
+"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Trial"
+"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"checkTrialEarlyStoppingState": {
-"description": "Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:checkTrialEarlyStoppingState",
+"streamQuery": {
+"description": "Streams queries using a reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState",
+"id": "aiplatform.reasoningEngines.streamQuery",
 "parameterOrder": [
-"trialName"
+"name"
 ],
 "parameters": {
-"trialName": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"name": {
+"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+trialName}:checkTrialEarlyStoppingState",
+"path": "v1beta1/{+name}:streamQuery",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1CheckTrialEarlyStoppingStateRequest"
+"$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest"
 },
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"complete": {
-"description": "Marks a Trial as complete.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:complete",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.complete",
+"resources": {
+"a2a": {
+"resources": {
+"v1": {
+"methods": {
+"card": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card",
+"httpMethod": "GET",
+"id": "aiplatform.reasoningEngines.a2a.v1.card",
 "parameterOrder": [
-"name"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"location": "path",
+"pattern": "^v1/card$",
+"required": true,
+"type": "string"
+},
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:complete",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CompleteTrialRequest"
-},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Trial"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"create": {
-"description": "Adds a user provided Trial to a Study.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
+"resources": {
+"message": {
+"methods": {
+"send": {
+"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.create",
+"id": "aiplatform.reasoningEngines.a2a.v1.message.send",
 "parameterOrder": [
-"parent"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Study to create the Trial in. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"a2aEndpoint": {
+"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^v1/message$",
+"required": true,
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"location": "path",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/trials",
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Trial"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Trial"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a Trial.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.trials.delete",
+"stream": {
+"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.a2a.v1.message.stream",
 "parameterOrder": [
-"name"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.",
+"location": "path",
+"pattern": "^v1/message$",
+"required": true,
+"type": "string"
+},
 "name": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream",
+"request": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
 "response": {
-"$ref": "GoogleProtobufEmpty"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"get": {
-"description": "Gets a Trial.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}",
+"tasks": {
+"methods": {
+"a2aGetReasoningEngine": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.get",
+"id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine",
 "parameterOrder": [
-"name"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
 "name": {
-"description": "Required. The name of the Trial resource. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Trial"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists the Trials associated with a Study.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.list",
+"cancel": {
+"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel",
 "parameterOrder": [
-"parent"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
-"pageSize": {
-"description": "Optional. The number of Trials to retrieve per \"page\" of results. If unspecified, the service will pick an appropriate default.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.",
-"location": "query",
+"a2aEndpoint": {
+"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+$",
+"required": true,
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Study to list the Trial from. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/trials",
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel",
+"request": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTrialsResponse"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"listOptimalTrials": {
-"description": "Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:listOptimalTrials",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.listOptimalTrials",
+"pushNotificationConfigs": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs",
+"httpMethod": "GET",
+"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs",
 "parameterOrder": [
-"parent"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The name of the Study that the optimal Trial belongs to.",
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/trials:listOptimalTrials",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsRequest"
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListOptimalTrialsResponse"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"stop": {
-"description": "Stops a Trial.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}:stop",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.stop",
+"subscribe": {
+"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe",
+"httpMethod": "GET",
+"id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe",
 "parameterOrder": [
-"name"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.",
+"location": "path",
+"pattern": "^v1/tasks/[^/]+$",
+"required": true,
+"type": "string"
+},
 "name": {
-"description": "Required. The Trial's name. Format: `projects/{project}/locations/{location}/studies/{study}/trials/{trial}`",
+"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:stop",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StopTrialRequest"
-},
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Trial"
+"$ref": "GoogleApiHttpBody"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"suggest": {
-"description": "Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials:suggest",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.suggest",
+"resources": {
+"pushNotificationConfigs": {
+"methods": {
+"a2aGetReasoningEngine": {
+"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
+"httpMethod": "GET",
+"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine",
 "parameterOrder": [
-"parent"
+"name",
+"a2aEndpoint"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The project and location that the Study belongs to. Format: `projects/{project}/locations/{location}/studies/{study}`",
+"a2aEndpoint": {
+"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+$",
+"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/trials:suggest",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SuggestTrialsRequest"
+"historyLength": {
+"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
+}
+}
+}
+}
 },
+"examples": {
 "resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.operations.cancel",
+"id": "aiplatform.reasoningEngines.examples.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -23511,7 +34400,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -23526,9 +34415,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.studies.trials.operations.delete",
+"id": "aiplatform.reasoningEngines.examples.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -23536,7 +34425,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -23551,9 +34440,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.operations.get",
+"id": "aiplatform.reasoningEngines.examples.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -23561,7 +34450,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -23574,57 +34463,11 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.studies.trials.operations.list",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"filter": {
-"description": "The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"name": {
-"description": "The name of the operation's parent resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+$",
-"required": true,
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token.",
-"location": "query",
-"type": "string"
-},
-"returnPartialSuccess": {
-"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
-"location": "query",
-"type": "boolean"
-}
-},
-"path": "v1beta1/{+name}/operations",
-"response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/examples/{examplesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.studies.trials.operations.wait",
+"id": "aiplatform.reasoningEngines.examples.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -23632,84 +34475,51 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/studies/[^/]+/trials/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:wait",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-}
-}
-}
-}
-},
-"tensorboards": {
-"methods": {
-"batchRead": {
-"description": "Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:batchRead",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.batchRead",
-"parameterOrder": [
-"tensorboard"
-],
-"parameters": {
-"tensorboard": {
-"description": "Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/examples/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"timeSeries": {
-"description": "Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+},
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
-"repeated": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+tensorboard}:batchRead",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchReadTensorboardTimeSeriesDataResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
+"memories": {
+"methods": {
 "create": {
-"description": "Creates a Tensorboard.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards",
+"description": "Create a Memory.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.create",
+"id": "aiplatform.reasoningEngines.memories.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/tensorboards",
+"path": "v1beta1/{+parent}/memories",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Tensorboard"
+"$ref": "GoogleCloudAiplatformV1beta1Memory"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -23719,18 +34529,18 @@
 ]
 },
 "delete": {
-"description": "Deletes a Tensorboard.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"description": "Delete a Memory.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.delete",
+"id": "aiplatform.reasoningEngines.memories.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Tensorboard to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -23743,101 +34553,123 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"generate": {
+"description": "Generate memories.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.memories.generate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"location": "path",
+"pattern": "^reasoningEngines/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+parent}/memories:generate",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
-"description": "Gets a Tensorboard.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"description": "Get a Memory.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.get",
+"id": "aiplatform.reasoningEngines.memories.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Tensorboard"
+"$ref": "GoogleCloudAiplatformV1beta1Memory"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Tensorboards in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards",
+"description": "List Memories.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.list",
+"id": "aiplatform.reasoningEngines.memories.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the Tensorboards that match the filter expression.",
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Field to use to sort the list.",
+"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100.",
+"description": "Optional. The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token.",
+"description": "Optional. The standard list page token.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the Location to list Tensorboards. Format: `projects/{project}/locations/{location}`",
+"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/tensorboards",
+"path": "v1beta1/{+parent}/memories",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardsResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a Tensorboard.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}",
+"description": "Update a Memory.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.patch",
+"id": "aiplatform.reasoningEngines.memories.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -23845,7 +34677,7 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1Tensorboard"
+"$ref": "GoogleCloudAiplatformV1beta1Memory"
 },
 "response": {
 "$ref": "GoogleLongrunningOperation"
@@ -23854,294 +34686,299 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"readSize": {
-"description": "Returns the storage size for a given TensorBoard instance.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readSize",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.readSize",
+"retrieve": {
+"description": "Retrieve memories.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.memories.retrieve",
 "parameterOrder": [
-"tensorboard"
+"parent"
 ],
 "parameters": {
-"tensorboard": {
-"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"parent": {
+"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+tensorboard}:readSize",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardSizeResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"readUsage": {
-"description": "Returns a list of monthly active users for a given TensorBoard instance.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}:readUsage",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.readUsage",
-"parameterOrder": [
-"tensorboard"
-],
-"parameters": {
-"tensorboard": {
-"description": "Required. The name of the Tensorboard resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
-"required": true,
-"type": "string"
-}
+"path": "v1beta1/{+parent}/memories:retrieve",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest"
 },
-"path": "v1beta1/{+tensorboard}:readUsage",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardUsageResponse"
+"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"experiments": {
-"methods": {
-"batchCreate": {
-"description": "Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:batchCreate",
+"rollback": {
+"description": "Rollback Memory to a specific revision.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}:rollback",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.batchCreate",
+"id": "aiplatform.reasoningEngines.memories.rollback",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment.",
+"name": {
+"description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}:batchCreate",
+"path": "v1beta1/{+name}:rollback",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesRequest"
+"$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardTimeSeriesResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"create": {
-"description": "Creates a TensorboardExperiment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.create",
+"id": "aiplatform.reasoningEngines.memories.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"tensorboardExperimentId": {
-"description": "Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/experiments",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a TensorboardExperiment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.delete",
+"id": "aiplatform.reasoningEngines.memories.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TensorboardExperiment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.get",
+"id": "aiplatform.reasoningEngines.memories.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardExperiment resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TensorboardExperiments in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.list",
+"id": "aiplatform.reasoningEngines.memories.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the TensorboardExperiments that match the filter expression.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Field to use to sort the list.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.memories.operations.wait",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/experiments",
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardExperimentsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"patch": {
-"description": "Updates a TensorboardExperiment.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.experiments.patch",
+"revisions": {
+"methods": {
+"get": {
+"description": "Get a Memory Revision.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions/{revisionsId}",
+"httpMethod": "GET",
+"id": "aiplatform.reasoningEngines.memories.revisions.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+/revisions/[^/]+$",
 "required": true,
 "type": "string"
-},
-"updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
-},
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardExperiment"
+"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"write": {
-"description": "Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}:write",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.write",
+"list": {
+"description": "List Memory Revisions for a Memory.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}/revisions",
+"httpMethod": "GET",
+"id": "aiplatform.reasoningEngines.memories.revisions.list",
 "parameterOrder": [
-"tensorboardExperiment"
+"parent"
 ],
 "parameters": {
-"tensorboardExperiment": {
-"description": "Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"filter": {
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+tensorboardExperiment}:write",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataRequest"
-},
+"path": "v1beta1/{+parent}/revisions",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardExperimentDataResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.cancel",
+"id": "aiplatform.reasoningEngines.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -24149,7 +34986,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24164,9 +35001,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.delete",
+"id": "aiplatform.reasoningEngines.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -24174,7 +35011,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24189,9 +35026,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.get",
+"id": "aiplatform.reasoningEngines.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -24199,7 +35036,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24214,9 +35051,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.list",
+"id": "aiplatform.reasoningEngines.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -24229,7 +35066,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -24260,9 +35097,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.operations.wait",
+"id": "aiplatform.reasoningEngines.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -24270,7 +35107,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -24291,228 +35128,150 @@
 }
 }
 },
-"runs": {
+"sandboxEnvironments": {
 "methods": {
-"batchCreate": {
-"description": "Batch create TensorboardRuns.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs:batchCreate",
+"create": {
+"description": "Creates a SandboxEnvironment in a given reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "parent": {
-"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` The parent field in the CreateTensorboardRunRequest messages must match this field.",
+"description": "Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/runs:batchCreate",
+"path": "v1beta1/{+parent}/sandboxEnvironments",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsRequest"
+"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1BatchCreateTensorboardRunsResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a TensorboardRun.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.create",
+"delete": {
+"description": "Deletes the specific SandboxEnvironment.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
+"name": {
+"description": "Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
 "required": true,
 "type": "string"
-},
-"tensorboardRunId": {
-"description": "Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/runs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a TensorboardRun.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.delete",
+"execute": {
+"description": "Executes using a sandbox environment.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:execute",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.execute",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardRun to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"description": "Required. The resource name of the sandbox environment to execute. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:execute",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TensorboardRun.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
+"description": "Gets details of the specific SandboxEnvironment.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.get",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardRun resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"description": "Required. The resource name of the sandbox environment. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
+"$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironment"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TensorboardRuns in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs",
+"description": "Lists SandboxEnvironments in a given reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.list",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the TensorboardRuns that match the filter expression.",
-"location": "query",
-"type": "string"
-},
-"orderBy": {
-"description": "Field to use to sort the list.",
+"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"description": "Optional. The maximum number of SandboxEnvironments to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironments will be returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
-"pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/runs",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardRunsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"patch": {
-"description": "Updates a TensorboardRun.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.patch",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardRun"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageToken": {
+"description": "Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page.",
+"location": "query",
+"type": "string"
 },
-"write": {
-"description": "Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}:write",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.write",
-"parameterOrder": [
-"tensorboardRun"
-],
-"parameters": {
-"tensorboardRun": {
-"description": "Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"parent": {
+"description": "Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+tensorboardRun}:write",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataRequest"
-},
+"path": "v1beta1/{+parent}/sandboxEnvironments",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1WriteTensorboardRunDataResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -24524,9 +35283,9 @@
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -24534,7 +35293,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24549,9 +35308,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -24559,7 +35318,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24574,9 +35333,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.get",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -24584,7 +35343,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24599,9 +35358,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.list",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -24614,7 +35373,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -24645,9 +35404,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait",
+"id": "aiplatform.reasoningEngines.sandboxEnvironments.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -24655,7 +35414,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -24675,60 +35434,60 @@
 ]
 }
 }
+}
+}
 },
-"timeSeries": {
+"sessions": {
 "methods": {
-"create": {
-"description": "Creates a TensorboardTimeSeries.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
+"appendEvent": {
+"description": "Appends an event to a given session.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create",
+"id": "aiplatform.reasoningEngines.sessions.appendEvent",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"name": {
+"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
 "required": true,
 "type": "string"
-},
-"tensorboardTimeSeriesId": {
-"description": "Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match \"a-z0-9{0, 127}\"",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/timeSeries",
+"path": "v1beta1/{+name}:appendEvent",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
+"$ref": "GoogleCloudAiplatformV1beta1SessionEvent"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
+"$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"delete": {
-"description": "Deletes a TensorboardTimeSeries.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete",
+"create": {
+"description": "Creates a new Session.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions",
+"httpMethod": "POST",
+"id": "aiplatform.reasoningEngines.sessions.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"parent": {
+"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+parent}/sessions",
+"request": {
+"$ref": "GoogleCloudAiplatformV1beta1Session"
+},
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
@@ -24736,129 +35495,120 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"exportTensorboardTimeSeries": {
-"description": "Exports a TensorboardTimeSeries' data. Data is returned in paginated responses.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:exportTensorboardTimeSeries",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries",
+"delete": {
+"description": "Deletes details of the specific Session.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.reasoningEngines.sessions.delete",
 "parameterOrder": [
-"tensorboardTimeSeries"
+"name"
 ],
 "parameters": {
-"tensorboardTimeSeries": {
-"description": "Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"name": {
+"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ExportTensorboardTimeSeriesDataResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TensorboardTimeSeries.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
+"description": "Gets details of the specific Session.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get",
+"id": "aiplatform.reasoningEngines.sessions.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
+"$ref": "GoogleCloudAiplatformV1beta1Session"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TensorboardTimeSeries in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries",
+"description": "Lists Sessions in a given reasoning engine.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list",
+"id": "aiplatform.reasoningEngines.sessions.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Lists the TensorboardTimeSeries that match the filter expression.",
+"description": "Optional. The standard list filter. Supported fields: * `display_name` * `user_id` Example: `display_name=\"abc\"`, `user_id=\"123\"`.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Field to use to sort the list.",
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
+"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token.",
+"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}`",
+"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+$",
 "required": true,
 "type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
 }
 },
-"path": "v1beta1/{+parent}/timeSeries",
+"path": "v1beta1/{+parent}/sessions",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTensorboardTimeSeriesResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "patch": {
-"description": "Updates a TensorboardTimeSeries.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}",
+"description": "Updates the specific Session.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
 "httpMethod": "PATCH",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch",
+"id": "aiplatform.reasoningEngines.sessions.patch",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Output only. Name of the TensorboardTimeSeries.",
+"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
 "required": true,
 "type": "string"
 },
 "updateMask": {
-"description": "Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified.",
+"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -24866,91 +35616,74 @@
 },
 "path": "v1beta1/{+name}",
 "request": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
+"$ref": "GoogleCloudAiplatformV1beta1Session"
 },
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TensorboardTimeSeries"
+"$ref": "GoogleCloudAiplatformV1beta1Session"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"read": {
-"description": "Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:read",
+"resources": {
+"events": {
+"methods": {
+"list": {
+"description": "Lists Events in a given session.",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read",
+"id": "aiplatform.reasoningEngines.sessions.events.list",
 "parameterOrder": [
-"tensorboardTimeSeries"
+"parent"
 ],
 "parameters": {
 "filter": {
-"description": "Reads the TensorboardTimeSeries' data that match the filter expression.",
+"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
 "type": "string"
 },
-"maxDataPoints": {
-"description": "The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data.",
-"format": "int32",
+"orderBy": {
+"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `timestamp` Example: `timestamp desc`.",
 "location": "query",
-"type": "integer"
-},
-"tensorboardTimeSeries": {
-"description": "Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
-"required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+tensorboardTimeSeries}:read",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardTimeSeriesDataResponse"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageSize": {
+"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"readBlobData": {
-"description": "Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}:readBlobData",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData",
-"parameterOrder": [
-"timeSeries"
-],
-"parameters": {
-"blobIds": {
-"description": "IDs of the blobs to read.",
+"pageToken": {
+"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.",
 "location": "query",
-"repeated": true,
 "type": "string"
 },
-"timeSeries": {
-"description": "Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}/timeSeries/{time_series}`",
+"parent": {
+"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+timeSeries}:readBlobData",
+"path": "v1beta1/{+parent}/events",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReadTensorboardBlobDataResponse"
+"$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
 },
-"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel",
+"id": "aiplatform.reasoningEngines.sessions.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -24958,7 +35691,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24973,9 +35706,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete",
+"id": "aiplatform.reasoningEngines.sessions.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -24983,7 +35716,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -24998,9 +35731,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get",
+"id": "aiplatform.reasoningEngines.sessions.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -25008,7 +35741,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25023,9 +35756,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list",
+"id": "aiplatform.reasoningEngines.sessions.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -25038,7 +35771,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -25069,9 +35802,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait",
+"id": "aiplatform.reasoningEngines.sessions.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -25079,7 +35812,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
+"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -25103,16 +35836,16 @@
 }
 }
 }
-}
-}
 },
+"schedules": {
+"resources": {
 "operations": {
 "methods": {
 "cancel": {
 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
+"flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.operations.cancel",
+"id": "aiplatform.schedules.operations.cancel",
 "parameterOrder": [
 "name"
 ],
@@ -25120,7 +35853,7 @@
 "name": {
 "description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25135,9 +35868,9 @@
 },
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
+"flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tensorboards.operations.delete",
+"id": "aiplatform.schedules.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -25145,7 +35878,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25160,9 +35893,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}",
+"flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.operations.get",
+"id": "aiplatform.schedules.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -25170,7 +35903,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25185,9 +35918,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations",
+"flatPath": "v1beta1/schedules/{schedulesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tensorboards.operations.list",
+"id": "aiplatform.schedules.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -25200,7 +35933,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+$",
+"pattern": "^schedules/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -25231,9 +35964,9 @@
 },
 "wait": {
 "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tensorboards/{tensorboardsId}/operations/{operationsId}:wait",
+"flatPath": "v1beta1/schedules/{schedulesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tensorboards.operations.wait",
+"id": "aiplatform.schedules.operations.wait",
 "parameterOrder": [
 "name"
 ],
@@ -25241,7 +35974,7 @@
 "name": {
 "description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tensorboards/[^/]+/operations/[^/]+$",
+"pattern": "^schedules/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -25264,195 +35997,15 @@
 }
 }
 },
-"trainingPipelines": {
-"methods": {
-"cancel": {
-"description": "Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the TrainingPipeline to cancel. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelTrainingPipelineRequest"
-},
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/trainingPipelines",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes a TrainingPipeline.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.trainingPipelines.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets a TrainingPipeline.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the TrainingPipeline resource. Format: `projects/{project}/locations/{location}/trainingPipelines/{training_pipeline}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1TrainingPipeline"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists TrainingPipelines in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines",
-"httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"filter": {
-"description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"PIPELINE_STATE_SUCCEEDED\" AND display_name:\"my_pipeline_*\"` * `state!=\"PIPELINE_STATE_FAILED\" OR display_name=\"my_pipeline\"` * `NOT display_name=\"my_pipeline\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `training_task_definition:\"*automl_text_classification*\"`",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"readMask": {
-"description": "Mask specifying which fields to read.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+parent}/trainingPipelines",
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTrainingPipelinesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
+"solvers": {
 "resources": {
 "operations": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.cancel",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:cancel",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+"flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.delete",
+"id": "aiplatform.solvers.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -25460,7 +36013,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
+"pattern": "^solvers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25475,9 +36028,9 @@
 },
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
+"flatPath": "v1beta1/solvers/{solversId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.get",
+"id": "aiplatform.solvers.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -25485,7 +36038,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
+"pattern": "^solvers/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25500,9 +36053,9 @@
 },
 "list": {
 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations",
+"flatPath": "v1beta1/solvers/{solversId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.list",
+"id": "aiplatform.solvers.operations.list",
 "parameterOrder": [
 "name"
 ],
@@ -25515,7 +36068,7 @@
 "name": {
 "description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+$",
+"pattern": "^solvers/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -25543,65 +36096,33 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"wait": {
-"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.trainingPipelines.operations.wait",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to wait on.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$",
-"required": true,
-"type": "string"
-},
-"timeout": {
-"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
-"format": "google-duration",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:wait",
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
 }
 }
 }
 }
 },
-"tuningJobs": {
+"specialistPools": {
+"resources": {
+"operations": {
 "methods": {
 "cancel": {
-"description": "Cancels a TuningJob. Starts asynchronous cancellation on the TuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the TuningJob is not deleted; instead it becomes a job with a TuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TuningJob.state is set to `CANCELLED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel",
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.cancel",
+"id": "aiplatform.specialistPools.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TuningJob to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}:cancel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CancelTuningJobRequest"
-},
 "response": {
 "$ref": "GoogleProtobufEmpty"
 },
@@ -25609,165 +36130,171 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"create": {
-"description": "Creates a TuningJob. A created TuningJob right away will be attempted to be run.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
-"httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.create",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.specialistPools.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the TuningJob in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/tuningJobs",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1TuningJob"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TuningJob"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a TuningJob.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tuningJobs.get",
+"id": "aiplatform.specialistPools.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the TuningJob resource. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1TuningJob"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists TuningJobs in a Location.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.projects.locations.tuningJobs.list",
+"id": "aiplatform.specialistPools.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^specialistPools/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJob][] call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the TuningJobs from. Format: `projects/{project}/locations/{location}`",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/tuningJobs",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListTuningJobsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"optimizePrompt": {
-"description": "Optimizes a prompt.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:optimizePrompt",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/specialistPools/{specialistPoolsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.optimizePrompt",
+"id": "aiplatform.specialistPools.operations.wait",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to optimize the prompt in. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^specialistPools/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/tuningJobs:optimizePrompt",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1OptimizePromptResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"rebaseTunedModel": {
-"description": "Rebase a TunedModel.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel",
+"studies": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel",
+"id": "aiplatform.studies.operations.cancel",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"operations": {
-"methods": {
 "delete": {
 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+"flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.projects.locations.tuningJobs.operations.delete",
+"id": "aiplatform.studies.operations.delete",
 "parameterOrder": [
 "name"
 ],
@@ -25775,7 +36302,7 @@
 "name": {
 "description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -25787,803 +36314,584 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
-}
-}
 },
-"modelGardenEula": {
-"methods": {
-"accept": {
-"description": "Accepts the EULA acceptance status of a publisher model.",
-"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:accept",
-"httpMethod": "POST",
-"id": "aiplatform.projects.modelGardenEula.accept",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "aiplatform.studies.operations.get",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The project requesting access for named model. The format is `projects/{project}`.",
+"name": {
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/modelGardenEula:accept",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1AcceptPublisherModelEulaRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"check": {
-"description": "Checks the EULA acceptance status of a publisher model.",
-"flatPath": "v1beta1/projects/{projectsId}/modelGardenEula:check",
-"httpMethod": "POST",
-"id": "aiplatform.projects.modelGardenEula.check",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/studies/{studiesId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.studies.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The project requesting access for named model. The format is `projects/{project}`.",
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^projects/[^/]+$",
+"pattern": "^studies/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/modelGardenEula:check",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CheckPublisherModelEulaAcceptanceRequest"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PublisherModelEulaAcceptance"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"publishers": {
-"resources": {
-"models": {
-"methods": {
-"enableModel": {
-"description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).",
-"flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/studies/{studiesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.projects.publishers.models.enableModel",
+"id": "aiplatform.studies.operations.wait",
 "parameterOrder": [
-"parent",
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^studies/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"parent": {
-"description": "Required. The project requesting access for named model. Format: `projects/{project}`",
-"location": "path",
-"pattern": "^projects/[^/]+$",
-"required": true,
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/{+name}:enableModel",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
-}
-}
-}
-}
 },
-"publishers": {
+"trials": {
 "resources": {
-"models": {
+"operations": {
 "methods": {
-"computeTokens": {
-"description": "Return a list of tokens based on the input text.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:computeTokens",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.publishers.models.computeTokens",
+"id": "aiplatform.studies.trials.operations.cancel",
 "parameterOrder": [
-"endpoint"
+"name"
 ],
 "parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to get lists of tokens and token ids.",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+endpoint}:computeTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ComputeTokensResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"countTokens": {
-"description": "Perform a token counting.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:countTokens",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.countTokens",
-"parameterOrder": [
-"endpoint"
-],
-"parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+endpoint}:countTokens",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1CountTokensResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"fetchPredictOperation": {
-"description": "Fetch an asynchronous online prediction operation.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:fetchPredictOperation",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.fetchPredictOperation",
-"parameterOrder": [
-"endpoint"
-],
-"parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+endpoint}:fetchPredictOperation",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1FetchPredictOperationRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"generateContent": {
-"description": "Generate content with multimodal inputs.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:generateContent",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.generateContent",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.studies.trials.operations.delete",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+model}:generateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a Model Garden publisher model.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.publishers.models.get",
+"id": "aiplatform.studies.trials.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"huggingFaceToken": {
-"description": "Optional. Token used to access Hugging Face gated models.",
-"location": "query",
-"type": "string"
-},
-"includeEquivalentModelGardenModelDeploymentConfigs": {
-"description": "Optional. Whether to cnclude the deployment configs from the equivalent Model Garden model if the requested model is a Hugging Face model.",
-"location": "query",
-"type": "boolean"
-},
-"isHuggingFaceModel": {
-"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.",
-"location": "query",
-"type": "boolean"
-},
-"languageCode": {
-"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-},
-"view": {
-"description": "Optional. PublisherModel view specifying which fields to read.",
-"enum": [
-"PUBLISHER_MODEL_VIEW_UNSPECIFIED",
-"PUBLISHER_MODEL_VIEW_BASIC",
-"PUBLISHER_MODEL_VIEW_FULL",
-"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
-],
-"enumDescriptions": [
-"The default / unset value. The API will default to the BASIC view.",
-"Include basic metadata about the publisher model, but not the full contents.",
-"Include everything.",
-"Include: VersionId, ModelVersionExternalName, and SupportedActions."
-],
-"location": "query",
-"type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1PublisherModel"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists publisher models in Model Garden.",
-"flatPath": "v1beta1/publishers/{publishersId}/models",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.publishers.models.list",
+"id": "aiplatform.studies.trials.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter.",
-"location": "query",
-"type": "string"
-},
-"languageCode": {
-"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"listAllVersions": {
-"description": "Optional. List all publisher model versions if the flag is set to true.",
-"location": "query",
-"type": "boolean"
-},
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^studies/[^/]+/trials/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`",
-"location": "path",
-"pattern": "^publishers/[^/]+$",
-"required": true,
-"type": "string"
-},
-"view": {
-"description": "Optional. PublisherModel view specifying which fields to read.",
-"enum": [
-"PUBLISHER_MODEL_VIEW_UNSPECIFIED",
-"PUBLISHER_MODEL_VIEW_BASIC",
-"PUBLISHER_MODEL_VIEW_FULL",
-"PUBLISHER_MODEL_VERSION_VIEW_BASIC"
-],
-"enumDescriptions": [
-"The default / unset value. The API will default to the BASIC view.",
-"Include basic metadata about the publisher model, but not the full contents.",
-"Include everything.",
-"Include: VersionId, ModelVersionExternalName, and SupportedActions."
-],
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/models",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"predict": {
-"description": "Perform an online prediction.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predict",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.predict",
-"parameterOrder": [
-"endpoint"
-],
-"parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+endpoint}:predict",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"predictLongRunning": {
-"description": "",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:predictLongRunning",
-"httpMethod": "POST",
-"id": "aiplatform.publishers.models.predictLongRunning",
-"parameterOrder": [
-"endpoint"
-],
-"parameters": {
-"endpoint": {
-"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`",
-"location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+endpoint}:predictLongRunning",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1PredictLongRunningRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
-]
-},
-"streamGenerateContent": {
-"description": "Generate content with multimodal inputs with streaming support.",
-"flatPath": "v1beta1/publishers/{publishersId}/models/{modelsId}:streamGenerateContent",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/studies/{studiesId}/trials/{trialsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.publishers.models.streamGenerateContent",
+"id": "aiplatform.studies.trials.operations.wait",
 "parameterOrder": [
-"model"
+"name"
 ],
 "parameters": {
-"model": {
-"description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^publishers/[^/]+/models/[^/]+$",
+"pattern": "^studies/[^/]+/trials/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+model}:streamGenerateContent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentRequest"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponse"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloud-platform.read-only"
+"https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
 }
 }
+}
+}
 },
-"reasoningEngines": {
+"tensorboards": {
+"resources": {
+"experiments": {
+"resources": {
+"operations": {
 "methods": {
-"create": {
-"description": "Creates a reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.create",
-"parameterOrder": [],
+"id": "aiplatform.tensorboards.experiments.operations.cancel",
+"parameterOrder": [
+"name"
+],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project}/locations/{location}`",
-"location": "query",
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/reasoningEngines",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes a reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.reasoningEngines.delete",
+"id": "aiplatform.tensorboards.experiments.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
-"force": {
-"description": "Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources.",
-"location": "query",
-"type": "boolean"
-},
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets a reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.get",
+"id": "aiplatform.tensorboards.experiments.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists reasoning engines in a location.",
-"flatPath": "v1beta1/reasoningEngines",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.list",
-"parameterOrder": [],
+"id": "aiplatform.tensorboards.experiments.operations.list",
+"parameterOrder": [
+"name"
+],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160).",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+$",
+"required": true,
+"type": "string"
+},
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project}/locations/{location}`",
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
 "location": "query",
-"type": "string"
+"type": "boolean"
 }
 },
-"path": "v1beta1/reasoningEngines",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListReasoningEnginesResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates a reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.reasoningEngines.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.tensorboards.experiments.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. Mask specifying which fields to update.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngine"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"query": {
-"description": "Queries using a reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:query",
+"runs": {
+"resources": {
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.query",
+"id": "aiplatform.tensorboards.experiments.runs.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:query",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineRequest"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1QueryReasoningEngineResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"streamQuery": {
-"description": "Streams queries using a reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}:streamQuery",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.streamQuery",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.tensorboards.experiments.runs.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the ReasoningEngine resource to use. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}:streamQuery",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1StreamQueryReasoningEngineRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"a2a": {
-"resources": {
-"v1": {
-"methods": {
-"card": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.a2a.v1.card",
+"id": "aiplatform.tensorboards.experiments.runs.operations.get",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
-"location": "path",
-"pattern": "^v1/card$",
-"required": true,
-"type": "string"
-},
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+name}",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
 },
-"resources": {
-"message": {
-"methods": {
-"send": {
-"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.a2a.v1.message.send",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations",
+"httpMethod": "GET",
+"id": "aiplatform.tensorboards.experiments.runs.operations.list",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
-"location": "path",
-"pattern": "^v1/message$",
-"required": true,
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
 "type": "string"
 },
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send",
-"request": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"type": "object"
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
 },
-"response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
 },
-"type": "object"
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"stream": {
-"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.a2a.v1.message.stream",
+"id": "aiplatform.tensorboards.experiments.runs.operations.wait",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^v1/message$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream",
-"request": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -26591,669 +36899,512 @@
 }
 }
 },
-"tasks": {
+"timeSeries": {
+"resources": {
+"operations": {
 "methods": {
-"a2aGetReasoningEngine": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}",
-"httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.cancel",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
-"location": "path",
-"pattern": "^v1/tasks/[^/]+$",
-"required": true,
-"type": "string"
-},
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"cancel": {
-"description": "Send post request for reasoning engine instance via the A2A post protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.delete",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send",
-"location": "path",
-"pattern": "^v1/tasks/[^/]+$",
-"required": true,
-"type": "string"
-},
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel",
-"request": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"pushNotificationConfigs": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs",
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.get",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
-"location": "path",
-"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$",
-"required": true,
-"type": "string"
-},
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
-"location": "query",
-"type": "string"
-},
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+name}",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"subscribe": {
-"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe",
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.list",
 "parameterOrder": [
-"name",
-"a2aEndpoint"
+"name"
 ],
 "parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.",
-"location": "path",
-"pattern": "^v1/tasks/[^/]+$",
-"required": true,
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
 "type": "string"
 },
 "name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL.",
+"description": "The name of the operation's parent resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+$",
 "required": true,
 "type": "string"
-}
-},
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe",
-"response": {
-"$ref": "GoogleApiHttpBody"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-},
-"resources": {
-"pushNotificationConfigs": {
-"methods": {
-"a2aGetReasoningEngine": {
-"description": "Get request for reasoning engine instance via the A2A get protocol apis.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}",
-"httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine",
-"parameterOrder": [
-"name",
-"a2aEndpoint"
-],
-"parameters": {
-"a2aEndpoint": {
-"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`",
-"location": "path",
-"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$",
-"required": true,
-"type": "string"
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"historyLength": {
-"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.",
+"pageToken": {
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
-},
-"type": "object"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
-}
-}
-}
-}
 },
-"memories": {
-"methods": {
-"create": {
-"description": "Create a Memory.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/experiments/{experimentsId}/runs/{runsId}/timeSeries/{timeSeriesId}/operations/{operationsId}:wait",
 "httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.memories.create",
+"id": "aiplatform.tensorboards.experiments.runs.timeSeries.operations.wait",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"name": {
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/experiments/[^/]+/runs/[^/]+/timeSeries/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
-}
 },
-"path": "v1beta1/{+parent}/memories",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Memory"
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
+"location": "query",
+"type": "string"
+}
 },
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
+}
+}
+}
+}
 },
-"delete": {
-"description": "Delete a Memory.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
-"httpMethod": "DELETE",
-"id": "aiplatform.reasoningEngines.memories.delete",
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "aiplatform.tensorboards.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"generate": {
-"description": "Generate memories.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:generate",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.memories.generate",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.tensorboards.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"parent": {
-"description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/memories:generate",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest"
-},
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Get a Memory.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.memories.get",
+"id": "aiplatform.tensorboards.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Memory"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "List Memories.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.memories.list",
+"id": "aiplatform.tensorboards.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `scope` (as a JSON string)",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^tensorboards/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The standard list page size.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The standard list page token.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/memories",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Update a Memory.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories/{memoriesId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.reasoningEngines.memories.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/tensorboards/{tensorboardsId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.tensorboards.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/memories/[^/]+$",
+"pattern": "^tensorboards/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Memory"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
 "$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"retrieve": {
-"description": "Retrieve memories.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/memories:retrieve",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.memories.retrieve",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
 }
-},
-"path": "v1beta1/{+parent}/memories:retrieve",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+}
 }
 }
 },
-"sessions": {
+"trainingPipelines": {
+"resources": {
+"operations": {
 "methods": {
-"appendEvent": {
-"description": "Appends an event to a given session.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}:appendEvent",
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:cancel",
 "httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.sessions.appendEvent",
+"id": "aiplatform.trainingPipelines.operations.cancel",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the session to append event to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+name}:appendEvent",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1SessionEvent"
-},
-"response": {
-"$ref": "GoogleCloudAiplatformV1beta1AppendEventResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"create": {
-"description": "Creates a new Session.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions",
-"httpMethod": "POST",
-"id": "aiplatform.reasoningEngines.sessions.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
+"description": "The name of the operation resource to be cancelled.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/sessions",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
-},
+"path": "v1beta1/{+name}:cancel",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "delete": {
-"description": "Deletes details of the specific Session.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
 "httpMethod": "DELETE",
-"id": "aiplatform.reasoningEngines.sessions.delete",
+"id": "aiplatform.trainingPipelines.operations.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "get": {
-"description": "Gets details of the specific Session.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.sessions.get",
+"id": "aiplatform.trainingPipelines.operations.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists Sessions in a given reasoning engine.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions",
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations",
 "httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.sessions.list",
+"id": "aiplatform.trainingPipelines.operations.list",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.",
+"description": "The standard list filter.",
 "location": "query",
 "type": "string"
 },
-"orderBy": {
-"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.",
-"location": "query",
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^trainingPipelines/[^/]+$",
+"required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.",
+"description": "The standard list page size.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.",
+"description": "The standard list page token.",
 "location": "query",
 "type": "string"
 },
-"parent": {
-"description": "Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`",
-"location": "path",
-"pattern": "^reasoningEngines/[^/]+$",
-"required": true,
-"type": "string"
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
-"path": "v1beta1/{+parent}/sessions",
+"path": "v1beta1/{+name}/operations",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListSessionsResponse"
+"$ref": "GoogleLongrunningListOperationsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"patch": {
-"description": "Updates the specific Session.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}",
-"httpMethod": "PATCH",
-"id": "aiplatform.reasoningEngines.sessions.patch",
+"wait": {
+"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.",
+"flatPath": "v1beta1/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait",
+"httpMethod": "POST",
+"id": "aiplatform.trainingPipelines.operations.wait",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.",
+"description": "The name of the operation resource to wait on.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^trainingPipelines/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"updateMask": {
-"description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.",
-"format": "google-fieldmask",
+"timeout": {
+"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.",
+"format": "google-duration",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1beta1/{+name}",
-"request": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
-},
+"path": "v1beta1/{+name}:wait",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1Session"
+"$ref": "GoogleLongrunningOperation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
+}
+}
+}
 },
+"tuningJobs": {
 "resources": {
-"events": {
+"operations": {
 "methods": {
-"list": {
-"description": "Lists Events in a given session.",
-"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sessions/{sessionsId}/events",
-"httpMethod": "GET",
-"id": "aiplatform.reasoningEngines.sessions.events.list",
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "aiplatform.tuningJobs.operations.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"filter": {
-"description": "Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp>=\"2025-01-31T11:30:00-04:00\"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160).",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The maximum number of events to return. The service may return fewer than this value. If unspecified, at most 100 events will be returned. These events are ordered by timestamp in ascending order.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. The next_page_token value returned from a previous list SessionService.ListEvents call.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The resource name of the session to list events from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}`",
+"name": {
+"description": "The name of the operation resource to be deleted.",
 "location": "path",
-"pattern": "^reasoningEngines/[^/]+/sessions/[^/]+$",
+"pattern": "^tuningJobs/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1beta1/{+parent}/events",
+"path": "v1beta1/{+name}",
 "response": {
-"$ref": "GoogleCloudAiplatformV1beta1ListEventsResponse"
+"$ref": "GoogleProtobufEmpty"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
@@ -27263,10 +37414,8 @@
 }
 }
 }
-}
-}
 },
-"revision": "20251003",
+"revision": "20251028",
 "rootUrl": "https://aiplatform.googleapis.com/",
 "schemas": {
 "CloudAiLargeModelsVisionGenerateVideoResponse": {
@@ -27877,6 +38026,10 @@
 "$ref": "GoogleCloudAiplatformV1beta1BleuMetricValue",
 "description": "Results for bleu metric."
 },
+"customCodeExecutionResult": {
+"$ref": "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult",
+"description": "Result for code execution metric."
+},
 "exactMatchMetricValue": {
 "$ref": "GoogleCloudAiplatformV1beta1ExactMatchMetricValue",
 "description": "Results for exact match metric."
@@ -29402,16 +39555,16 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1Blob": {
-"description": "Content blob.",
+"description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.",
 "id": "GoogleCloudAiplatformV1beta1Blob",
 "properties": {
 "data": {
-"description": "Required. Raw bytes.",
+"description": "Required. The raw bytes of the data.",
 "format": "byte",
 "type": "string"
 },
 "displayName": {
-"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.",
 "type": "string"
 },
 "mimeType": {
@@ -29625,28 +39778,28 @@
 "id": "GoogleCloudAiplatformV1beta1Candidate",
 "properties": {
 "avgLogprobs": {
-"description": "Output only. Average log probability score of the candidate.",
+"description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.",
 "format": "double",
 "readOnly": true,
 "type": "number"
 },
 "citationMetadata": {
 "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata",
-"description": "Output only. Source attribution of the generated content.",
+"description": "Output only. A collection of citations that apply to the generated content.",
 "readOnly": true
 },
 "content": {
 "$ref": "GoogleCloudAiplatformV1beta1Content",
-"description": "Output only. Content parts of the candidate.",
+"description": "Output only. The content of the candidate.",
 "readOnly": true
 },
 "finishMessage": {
-"description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.",
+"description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.",
 "readOnly": true,
 "type": "string"
 },
 "finishReason": {
-"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.",
+"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.",
 "enum": [
 "FINISH_REASON_UNSPECIFIED",
 "STOP",
@@ -29668,44 +39821,44 @@
 ],
 "enumDescriptions": [
 "The finish reason is unspecified.",
-"Token generation reached a natural stopping point or a configured stop sequence.",
-"Token generation reached the configured maximum output tokens.",
-"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.",
-"The token generation stopped because of potential recitation.",
-"All other reasons that stopped the token generation.",
-"Token generation stopped because the content contains forbidden terms.",
-"Token generation stopped for potentially containing prohibited content.",
-"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).",
-"The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).",
+"The model reached a natural stopping point or a configured stop sequence.",
+"The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.",
+"The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.",
+"The model stopped generating because the content may be a recitation from a source.",
+"The model stopped generating for a reason not otherwise specified.",
+"The model stopped generating because the content contains a term from a configured blocklist.",
+"The model stopped generating because the content may be prohibited.",
+"The model stopped generating because the content may contain sensitive personally identifiable information (SPII).",
+"The model generated a function call that is syntactically invalid and can't be parsed.",
 "The model response was blocked by Model Armor.",
-"Token generation stopped because generated images has safety violations.",
-"Image generation stopped because generated images has other prohibited content.",
-"Image generation stopped due to recitation.",
-"Image generation stopped because of other miscellaneous issue.",
-"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).",
-"The model was expected to generate an image, but none was generated."
+"The generated image potentially violates safety policies.",
+"The generated image may contain prohibited content.",
+"The generated image may be a recitation from a source.",
+"The image generation stopped for a reason not otherwise specified.",
+"The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.",
+"The model was expected to generate an image, but didn't."
 ],
 "readOnly": true,
 "type": "string"
 },
 "groundingMetadata": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata",
-"description": "Output only. Metadata specifies sources used to ground generated content.",
+"description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.",
 "readOnly": true
 },
 "index": {
-"description": "Output only. Index of the candidate.",
+"description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "logprobsResult": {
 "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult",
-"description": "Output only. Log-likelihood scores for the response tokens and top tokens",
+"description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".",
 "readOnly": true
 },
 "safetyRatings": {
-"description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.",
+"description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1SafetyRating"
 },
@@ -29714,7 +39867,7 @@
 },
 "urlContextMetadata": {
 "$ref": "GoogleCloudAiplatformV1beta1UrlContextMetadata",
-"description": "Output only. Metadata related to url context retrieval tool.",
+"description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.",
 "readOnly": true
 }
 },
@@ -29728,6 +39881,13 @@
 "description": "Required. The name of the candidate that produced the response.",
 "type": "string"
 },
+"events": {
+"description": "Optional. Intermediate events (such as tool calls and responses) that led to the final response.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Content"
+},
+"type": "array"
+},
 "text": {
 "description": "Text response.",
 "type": "string"
@@ -29863,38 +40023,38 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1Citation": {
-"description": "Source attributions for content.",
+"description": "A citation for a piece of generatedcontent.",
 "id": "GoogleCloudAiplatformV1beta1Citation",
 "properties": {
 "endIndex": {
-"description": "Output only. End index into the content.",
+"description": "Output only. The end index of the citation in the content.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "license": {
-"description": "Output only. License of the attribution.",
+"description": "Output only. The license of the source of the citation.",
 "readOnly": true,
 "type": "string"
 },
 "publicationDate": {
 "$ref": "GoogleTypeDate",
-"description": "Output only. Publication date of the attribution.",
+"description": "Output only. The publication date of the source of the citation.",
 "readOnly": true
 },
 "startIndex": {
-"description": "Output only. Start index into the content.",
+"description": "Output only. The start index of the citation in the content.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "title": {
-"description": "Output only. Title of the attribution.",
+"description": "Output only. The title of the source of the citation.",
 "readOnly": true,
 "type": "string"
 },
 "uri": {
-"description": "Output only. Url reference of the attribution.",
+"description": "Output only. The URI of the source of the citation.",
 "readOnly": true,
 "type": "string"
 }
@@ -29902,11 +40062,11 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1CitationMetadata": {
-"description": "A collection of source attributions for a piece of content.",
+"description": "A collection of citations that apply to a piece of generated content.",
 "id": "GoogleCloudAiplatformV1beta1CitationMetadata",
 "properties": {
 "citations": {
-"description": "Output only. List of citations.",
+"description": "Output only. A list of citations for the content.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1Citation"
 },
@@ -30270,18 +40430,18 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1Content": {
-"description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.",
+"description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.",
 "id": "GoogleCloudAiplatformV1beta1Content",
 "properties": {
 "parts": {
-"description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.",
+"description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1Part"
 },
 "type": "array"
 },
 "role": {
-"description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.",
+"description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.",
 "type": "string"
 }
 },
@@ -30673,7 +40833,9 @@
 "GETTING_CONTAINER_IMAGE",
 "STARTING_MODEL_SERVER",
 "FINISHING_UP",
-"DEPLOYMENT_TERMINATED"
+"DEPLOYMENT_TERMINATED",
+"SUCCESSFULLY_DEPLOYED",
+"FAILED_TO_DEPLOY"
 ],
 "enumDescriptions": [
 "Default value. This value is unused.",
@@ -30684,7 +40846,9 @@
 "The deployment is getting the container image for the model server.",
 "The deployment is starting the model server.",
 "The deployment is performing finalization steps.",
-"The deployment has terminated."
+"The deployment has terminated.",
+"The deployment has succeeded.",
+"The deployment has failed."
 ],
 "readOnly": true,
 "type": "string"
@@ -31042,6 +41206,30 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1CustomCodeExecutionResult": {
+"description": "Result for custom code execution metric.",
+"id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionResult",
+"properties": {
+"score": {
+"description": "Output only. Custom code execution score.",
+"format": "float",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec": {
+"description": "Specificies a metric that is populated by evaluating user-defined Python code.",
+"id": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec",
+"properties": {
+"evaluationFunction": {
+"description": "Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text=\"The answer is 4.\"), reference=EvaluationInstance.InstanceData(text=\"4\") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ```",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1CustomJob": {
 "description": "Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).",
 "id": "GoogleCloudAiplatformV1beta1CustomJob",
@@ -31805,7 +41993,7 @@
 "id": "GoogleCloudAiplatformV1beta1DedicatedResourcesScaleToZeroSpec",
 "properties": {
 "idleScaledownPeriod": {
-"description": "Optional. Duration of no traffic before scaling to zero. [MinValue=3600] (5 minutes) [MaxValue=28800] (8 hours)",
+"description": "Optional. Duration of no traffic before scaling to zero. [MinValue=300] (5 minutes) [MaxValue=28800] (8 hours)",
 "format": "google-duration",
 "type": "string"
 },
@@ -32001,7 +42189,9 @@
 "GETTING_CONTAINER_IMAGE",
 "STARTING_MODEL_SERVER",
 "FINISHING_UP",
-"DEPLOYMENT_TERMINATED"
+"DEPLOYMENT_TERMINATED",
+"SUCCESSFULLY_DEPLOYED",
+"FAILED_TO_DEPLOY"
 ],
 "enumDescriptions": [
 "Default value. This value is unused.",
@@ -32012,7 +42202,9 @@
 "The deployment is getting the container image for the model server.",
 "The deployment is starting the model server.",
 "The deployment is performing finalization steps.",
-"The deployment has terminated."
+"The deployment has terminated.",
+"The deployment has succeeded.",
+"The deployment has failed."
 ],
 "readOnly": true,
 "type": "string"
@@ -32806,11 +42998,96 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1EmbedContentRequest": {
+"description": "Request message for PredictionService.EmbedContent.",
+"id": "GoogleCloudAiplatformV1beta1EmbedContentRequest",
+"properties": {
+"autoTruncate": {
+"description": "Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.",
+"type": "boolean"
+},
+"content": {
+"$ref": "GoogleCloudAiplatformV1beta1Content",
+"description": "Required. Input content to be embedded. Required."
+},
+"outputDimensionality": {
+"description": "Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.",
+"format": "int32",
+"type": "integer"
+},
+"taskType": {
+"description": "Optional. The task type of the embedding.",
+"enum": [
+"UNSPECIFIED",
+"RETRIEVAL_QUERY",
+"RETRIEVAL_DOCUMENT",
+"SEMANTIC_SIMILARITY",
+"CLASSIFICATION",
+"CLUSTERING",
+"QUESTION_ANSWERING",
+"FACT_VERIFICATION",
+"CODE_RETRIEVAL_QUERY"
+],
+"enumDescriptions": [
+"Unset value, which will default to one of the other enum values.",
+"Specifies the given text is a query in a search/retrieval setting.",
+"Specifies the given text is a document from the corpus being searched.",
+"Specifies the given text will be used for STS.",
+"Specifies that the given text will be classified.",
+"Specifies that the embeddings will be used for clustering.",
+"Specifies that the embeddings will be used for question answering.",
+"Specifies that the embeddings will be used for fact verification.",
+"Specifies that the embeddings will be used for code retrieval."
+],
+"type": "string"
+},
+"title": {
+"description": "Optional. An optional title for the text.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1EmbedContentResponse": {
+"description": "Response message for PredictionService.EmbedContent.",
+"id": "GoogleCloudAiplatformV1beta1EmbedContentResponse",
+"properties": {
+"embedding": {
+"$ref": "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding",
+"description": "The embedding generated from the input content."
+},
+"truncated": {
+"description": "Whether the input content was truncated before generating the embedding.",
+"type": "boolean"
+},
+"usageMetadata": {
+"$ref": "GoogleCloudAiplatformV1beta1UsageMetadata",
+"description": "Metadata about the response(s)."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding": {
+"description": "A list of floats representing an embedding.",
+"id": "GoogleCloudAiplatformV1beta1EmbedContentResponseEmbedding",
+"properties": {
+"values": {
+"description": "Embedding vector values.",
+"items": {
+"format": "float",
+"type": "number"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1EnableModelRequest": {
 "description": "Request message for ModelGardenService.EnableModel.",
 "id": "GoogleCloudAiplatformV1beta1EnableModelRequest",
 "properties": {
 "service": {
+"deprecated": true,
 "description": "Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`",
 "type": "string"
 }
@@ -33632,6 +43909,10 @@
 "description": "A single instance to be evaluated. Instances are used to specify the input data for evaluation, from simple string comparisons to complex, multi-turn model evaluations",
 "id": "GoogleCloudAiplatformV1beta1EvaluationInstance",
 "properties": {
+"agentData": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData",
+"description": "Optional. Data used for agent evaluation."
+},
 "otherData": {
 "$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceMapInstance",
 "description": "Optional. Other data used to populate placeholders based on their key."
@@ -33658,6 +43939,102 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig": {
+"description": "Configuration for an Agent.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig",
+"properties": {
+"developerInstruction": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData",
+"description": "Optional. A field containing instructions from the developer for the agent."
+},
+"tools": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools",
+"description": "List of tools."
+},
+"toolsText": {
+"description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools": {
+"description": "Represents a list of tools for an agent.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfigTools",
+"properties": {
+"tool": {
+"description": "Optional. List of tools: each tool can have multiple function declarations.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Tool"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData": {
+"description": "Contains data specific to agent evaluations.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData",
+"properties": {
+"agentConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig",
+"description": "Optional. Agent configuration."
+},
+"developerInstruction": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData",
+"deprecated": true,
+"description": "Optional. A field containing instructions from the developer for the agent."
+},
+"events": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents",
+"description": "A list of events."
+},
+"eventsText": {
+"description": "A JSON string containing a sequence of events.",
+"type": "string"
+},
+"tools": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools",
+"deprecated": true,
+"description": "List of tools."
+},
+"toolsText": {
+"deprecated": true,
+"description": "A JSON string containing a list of tools available to an agent with info such as name, description, parameters and required parameters. Example: [ { \"name\": \"search_actors\", \"description\": \"Search for actors in a movie. Returns a list of actors, their roles, their birthdate, and their place of birth.\", \"parameters\": [ { \"name\": \"movie_name\", \"description\": \"The name of the movie.\" }, { \"name\": \"character_name\", \"description\": \"The name of the character.\" } ], \"required\": [\"movie_name\", \"character_name\"] } ]",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents": {
+"description": "Represents a list of events for an agent.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents",
+"properties": {
+"event": {
+"description": "Optional. A list of events.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Content"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools": {
+"description": "Represents a list of tools for an agent.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools",
+"properties": {
+"tool": {
+"deprecated": true,
+"description": "Optional. List of tools: each tool can have multiple function declarations.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Tool"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData": {
 "description": "Instance data used to populate placeholders in a metric prompt template.",
 "id": "GoogleCloudAiplatformV1beta1EvaluationInstanceInstanceData",
@@ -34090,6 +44467,10 @@
 "description": "An inference config used for model inference during the evaluation run.",
 "id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig",
 "properties": {
+"agentConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig",
+"description": "Optional. Agent config used to generate responses."
+},
 "generationConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig",
 "description": "Optional. Generation config."
@@ -34101,6 +44482,24 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig": {
+"description": "Configuration that describes an agent.",
+"id": "GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig",
+"properties": {
+"developerInstruction": {
+"$ref": "GoogleCloudAiplatformV1beta1Content",
+"description": "Optional. The developer instruction for the agent."
+},
+"tools": {
+"description": "Optional. The tools available to the agent.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1Tool"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1EvaluationRunMetric": {
 "description": "The metric used for evaluation runs.",
 "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetric",
@@ -34113,6 +44512,10 @@
 "description": "Required. The name of the metric.",
 "type": "string"
 },
+"metricConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1Metric",
+"description": "The metric config."
+},
 "predefinedMetricSpec": {
 "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricPredefinedMetricSpec",
 "description": "Spec for a pre-defined metric."
@@ -34381,11 +44784,6 @@
 "transferAgent": {
 "description": "Optional. If set, the event transfers to the specified agent.",
 "type": "string"
-},
-"transferToAgent": {
-"deprecated": true,
-"description": "Deprecated. If set, the event transfers to the specified agent.",
-"type": "boolean"
 }
 },
 "type": "object"
@@ -37597,15 +47995,15 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1FileData": {
-"description": "URI based data.",
+"description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.",
 "id": "GoogleCloudAiplatformV1beta1FileData",
 "properties": {
 "displayName": {
-"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.",
 "type": "string"
 },
 "fileUri": {
-"description": "Required. URI.",
+"description": "Required. The URI of the file in Google Cloud Storage.",
 "type": "string"
 },
 "mimeType": {
@@ -38062,6 +48460,13 @@
 "description": "Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name].",
 "type": "string"
 },
+"parts": {
+"description": "Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1FunctionResponsePart"
+},
+"type": "array"
+},
 "response": {
 "additionalProperties": {
 "description": "Properties of the object.",
@@ -38073,6 +48478,60 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1FunctionResponseBlob": {
+"description": "Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field.",
+"id": "GoogleCloudAiplatformV1beta1FunctionResponseBlob",
+"properties": {
+"data": {
+"description": "Required. Raw bytes.",
+"format": "byte",
+"type": "string"
+},
+"displayName": {
+"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"type": "string"
+},
+"mimeType": {
+"description": "Required. The IANA standard MIME type of the source data.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1FunctionResponseFileData": {
+"description": "URI based data for function response.",
+"id": "GoogleCloudAiplatformV1beta1FunctionResponseFileData",
+"properties": {
+"displayName": {
+"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.",
+"type": "string"
+},
+"fileUri": {
+"description": "Required. URI.",
+"type": "string"
+},
+"mimeType": {
+"description": "Required. The IANA standard MIME type of the source data.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1FunctionResponsePart": {
+"description": "A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.",
+"id": "GoogleCloudAiplatformV1beta1FunctionResponsePart",
+"properties": {
+"fileData": {
+"$ref": "GoogleCloudAiplatformV1beta1FunctionResponseFileData",
+"description": "URI based data."
+},
+"inlineData": {
+"$ref": "GoogleCloudAiplatformV1beta1FunctionResponseBlob",
+"description": "Inline media bytes."
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1GcsDestination": {
 "description": "The Google Cloud Storage location where the output is to be written to.",
 "id": "GoogleCloudAiplatformV1beta1GcsDestination",
@@ -38544,6 +49003,10 @@
 "description": "Request message for EvaluationService.GenerateInstanceRubrics.",
 "id": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest",
 "properties": {
+"agentConfig": {
+"$ref": "GoogleCloudAiplatformV1beta1EvaluationInstanceAgentConfig",
+"description": "Optional. Agent configuration, required for agent-based rubric generation."
+},
 "contents": {
 "description": "Required. The prompt to generate rubrics from. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.",
 "items": {
@@ -38593,6 +49056,27 @@
 "description": "Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled.",
 "type": "boolean"
 },
+"disableMemoryRevisions": {
+"description": "Optional. If true, no revisions will be created for this request.",
+"type": "boolean"
+},
+"revisionExpireTime": {
+"description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.",
+"format": "google-datetime",
+"type": "string"
+},
+"revisionLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.",
+"type": "object"
+},
+"revisionTtl": {
+"description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.",
+"format": "google-duration",
+"type": "string"
+},
 "scope": {
 "additionalProperties": {
 "type": "string"
@@ -38653,6 +49137,13 @@
 "fact": {
 "description": "Required. The fact to consolidate with existing memories.",
 "type": "string"
+},
+"topics": {
+"description": "Optional. The topics that the consolidated memories should be associated with.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -38776,24 +49267,24 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GenerationConfig": {
-"description": "Generation config.",
+"description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.",
 "id": "GoogleCloudAiplatformV1beta1GenerationConfig",
 "properties": {
 "audioTimestamp": {
-"description": "Optional. If enabled, audio timestamp will be included in the request to the model.",
+"description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.",
 "type": "boolean"
 },
 "candidateCount": {
-"description": "Optional. Number of candidates to generate.",
+"description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.",
 "format": "int32",
 "type": "integer"
 },
 "enableAffectiveDialog": {
-"description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.",
+"description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.",
 "type": "boolean"
 },
 "frequencyPenalty": {
-"description": "Optional. Frequency penalties.",
+"description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].",
 "format": "float",
 "type": "number"
 },
@@ -38802,17 +49293,17 @@
 "description": "Optional. Config for image generation features."
 },
 "logprobs": {
-"description": "Optional. Logit probabilities.",
+"description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.",
 "format": "int32",
 "type": "integer"
 },
 "maxOutputTokens": {
-"description": "Optional. The maximum number of output tokens to generate per message.",
+"description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.",
 "format": "int32",
 "type": "integer"
 },
 "mediaResolution": {
-"description": "Optional. If specified, the media resolution specified will be used.",
+"description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.",
 "enum": [
 "MEDIA_RESOLUTION_UNSPECIFIED",
 "MEDIA_RESOLUTION_LOW",
@@ -38833,24 +49324,24 @@
 "description": "Optional. Config for model selection."
 },
 "presencePenalty": {
-"description": "Optional. Positive penalties.",
+"description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].",
 "format": "float",
 "type": "number"
 },
 "responseJsonSchema": {
-"description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.",
+"description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.",
 "type": "any"
 },
 "responseLogprobs": {
-"description": "Optional. If true, export the logprobs results in response.",
+"description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.",
 "type": "boolean"
 },
 "responseMimeType": {
-"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
+"description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
 "type": "string"
 },
 "responseModalities": {
-"description": "Optional. The modalities of the response.",
+"description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.",
 "items": {
 "enum": [
 "MODALITY_UNSPECIFIED",
@@ -38870,14 +49361,14 @@
 },
 "responseSchema": {
 "$ref": "GoogleCloudAiplatformV1beta1Schema",
-"description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response."
+"description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`."
 },
 "routingConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig",
 "description": "Optional. Routing configuration."
 },
 "seed": {
-"description": "Optional. Seed.",
+"description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.",
 "format": "int32",
 "type": "integer"
 },
@@ -38886,28 +49377,28 @@
 "description": "Optional. The speech generation config."
 },
 "stopSequences": {
-"description": "Optional. Stop sequences.",
+"description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "temperature": {
-"description": "Optional. Controls the randomness of predictions.",
+"description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].",
 "format": "float",
 "type": "number"
 },
 "thinkingConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig",
-"description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking."
+"description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking."
 },
 "topK": {
-"description": "Optional. If specified, top-k sampling will be used.",
+"description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.",
 "format": "float",
 "type": "number"
 },
 "topP": {
-"description": "Optional. If specified, nucleus sampling will be used.",
+"description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.",
 "format": "float",
 "type": "number"
 }
@@ -38938,22 +49429,22 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": {
-"description": "The configuration for routing the request to a specific model.",
+"description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.",
 "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig",
 "properties": {
 "autoMode": {
 "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode",
-"description": "Automated routing."
+"description": "In this mode, the model is selected automatically based on the content of the request."
 },
 "manualMode": {
 "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode",
-"description": "Manual routing."
+"description": "In this mode, the model is specified manually."
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": {
-"description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
+"description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.",
 "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode",
 "properties": {
 "modelRoutingPreference": {
@@ -38966,9 +49457,9 @@
 ],
 "enumDescriptions": [
 "Unspecified model routing preference.",
-"Prefer higher quality over low cost.",
-"Balanced model routing preference.",
-"Prefer lower cost over higher quality."
+"The model will be selected to prioritize the quality of the response.",
+"The model will be selected to balance quality and cost.",
+"The model will be selected to prioritize the cost of the request."
 ],
 "type": "string"
 }
@@ -38976,26 +49467,26 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": {
-"description": "When manual routing is set, the specified model will be used directly.",
+"description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.",
 "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode",
 "properties": {
 "modelName": {
-"description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).",
+"description": "The name of the model to use. Only public LLM models are accepted.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": {
-"description": "Config for thinking features.",
+"description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.",
 "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig",
 "properties": {
 "includeThoughts": {
-"description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.",
+"description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.",
 "type": "boolean"
 },
 "thinkingBudget": {
-"description": "Optional. Indicates the thinking budget in tokens.",
+"description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.",
 "format": "int32",
 "type": "integer"
 }
@@ -39168,57 +49659,57 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingChunk": {
-"description": "Grounding chunk.",
+"description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.",
 "id": "GoogleCloudAiplatformV1beta1GroundingChunk",
 "properties": {
 "maps": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps",
-"description": "Grounding chunk from Google Maps."
+"description": "A grounding chunk from Google Maps. See the `Maps` message for details."
 },
 "retrievedContext": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext",
-"description": "Grounding chunk from context retrieved by the retrieval tools."
+"description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details"
 },
 "web": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb",
-"description": "Grounding chunk from the web."
+"description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details."
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingChunkMaps": {
-"description": "Chunk from Google Maps.",
+"description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.",
 "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps",
 "properties": {
 "placeAnswerSources": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources",
-"description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content."
+"description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content."
 },
 "placeId": {
-"description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.",
+"description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.",
 "type": "string"
 },
 "text": {
-"description": "Text of the place answer.",
+"description": "The text of the place answer.",
 "type": "string"
 },
 "title": {
-"description": "Title of the place.",
+"description": "The title of the place.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the place.",
+"description": "The URI of the place.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources": {
-"description": "Sources used to generate the place answer.",
+"description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.",
 "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources",
 "properties": {
 "reviewSnippets": {
-"description": "Snippets of reviews that are used to generate the answer.",
+"description": "Snippets of reviews that were used to generate the answer.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet"
 },
@@ -39228,7 +49719,7 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": {
-"description": "Encapsulates a review snippet.",
+"description": "A review snippet that is used to generate the answer.",
 "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet",
 "properties": {
 "googleMapsUri": {
@@ -39236,81 +49727,81 @@
 "type": "string"
 },
 "reviewId": {
-"description": "Id of the review referencing the place.",
+"description": "The ID of the review that is being referenced.",
 "type": "string"
 },
 "title": {
-"description": "Title of the review.",
+"description": "The title of the review.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": {
-"description": "Chunk from context retrieved by the retrieval tools.",
+"description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.",
 "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext",
 "properties": {
 "documentName": {
-"description": "Output only. The full document name for the referenced Vertex AI Search document.",
+"description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.",
 "readOnly": true,
 "type": "string"
 },
 "ragChunk": {
 "$ref": "GoogleCloudAiplatformV1beta1RagChunk",
-"description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool."
+"description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used."
 },
 "text": {
-"description": "Text of the attribution.",
+"description": "The content of the retrieved data source.",
 "type": "string"
 },
 "title": {
-"description": "Title of the attribution.",
+"description": "The title of the retrieved data source.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the attribution.",
+"description": "The URI of the retrieved data source.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingChunkWeb": {
-"description": "Chunk from the web.",
+"description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.",
 "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb",
 "properties": {
 "domain": {
-"description": "Domain of the (original) URI.",
+"description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.",
 "type": "string"
 },
 "title": {
-"description": "Title of the chunk.",
+"description": "The title of the web page that contains the evidence.",
 "type": "string"
 },
 "uri": {
-"description": "URI reference of the chunk.",
+"description": "The URI of the web page that contains the evidence.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingMetadata": {
-"description": "Metadata returned to client when grounding is enabled.",
+"description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.",
 "id": "GoogleCloudAiplatformV1beta1GroundingMetadata",
 "properties": {
 "googleMapsWidgetContextToken": {
-"description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.",
+"description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.",
 "readOnly": true,
 "type": "string"
 },
 "groundingChunks": {
-"description": "List of supporting references retrieved from specified grounding source.",
+"description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk"
 },
 "type": "array"
 },
 "groundingSupports": {
-"description": "Optional. List of grounding support.",
+"description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport"
 },
@@ -39318,11 +49809,11 @@
 },
 "retrievalMetadata": {
 "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
-"description": "Optional. Output only. Retrieval metadata.",
+"description": "Optional. Output only. Metadata related to the retrieval grounding source.",
 "readOnly": true
 },
 "retrievalQueries": {
-"description": "Optional. Queries executed by the retrieval tools.",
+"description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.",
 "items": {
 "type": "string"
 },
@@ -39330,10 +49821,10 @@
 },
 "searchEntryPoint": {
 "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint",
-"description": "Optional. Google search entry for the following-up web searches."
+"description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search."
 },
 "sourceFlaggingUris": {
-"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.",
+"description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri"
 },
@@ -39341,7 +49832,7 @@
 "type": "array"
 },
 "webSearchQueries": {
-"description": "Optional. Web search queries for the following-up web search.",
+"description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.",
 "items": {
 "type": "string"
 },
@@ -39351,26 +49842,26 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": {
-"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.",
+"description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.",
 "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri",
 "properties": {
 "flagContentUri": {
-"description": "A link where users can flag a problem with the source (place or review).",
+"description": "The URI that can be used to flag the content.",
 "type": "string"
 },
 "sourceId": {
-"description": "Id of the place or review.",
+"description": "The ID of the place or review.",
 "type": "string"
 }
 },
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1GroundingSupport": {
-"description": "Grounding support.",
+"description": "A collection of supporting references for a segment of the model's response.",
 "id": "GoogleCloudAiplatformV1beta1GroundingSupport",
 "properties": {
 "confidenceScores": {
-"description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.",
+"description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.",
 "items": {
 "format": "float",
 "type": "number"
@@ -39378,7 +49869,7 @@
 "type": "array"
 },
 "groundingChunkIndices": {
-"description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.",
+"description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.",
 "items": {
 "format": "int32",
 "type": "integer"
@@ -39387,7 +49878,7 @@
 },
 "segment": {
 "$ref": "GoogleCloudAiplatformV1beta1Segment",
-"description": "Segment of the content this support belongs to."
+"description": "The content segment that this support message applies to."
 }
 },
 "type": "object"
@@ -39537,12 +50028,48 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1ImageConfig": {
-"description": "Config for image generation features.",
+"description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.",
 "id": "GoogleCloudAiplatformV1beta1ImageConfig",
 "properties": {
 "aspectRatio": {
 "description": "Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: \"1:1\" \"2:3\", \"3:2\" \"3:4\", \"4:3\" \"4:5\", \"5:4\" \"9:16\", \"16:9\" \"21:9\"",
 "type": "string"
+},
+"imageOutputOptions": {
+"$ref": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions",
+"description": "Optional. The image output format for generated images."
+},
+"personGeneration": {
+"description": "Optional. Controls whether the model can generate people.",
+"enum": [
+"PERSON_GENERATION_UNSPECIFIED",
+"ALLOW_ALL",
+"ALLOW_ADULT",
+"ALLOW_NONE"
+],
+"enumDescriptions": [
+"The default behavior is unspecified. The model will decide whether to generate images of people.",
+"Allows the model to generate images of people, including adults and children.",
+"Allows the model to generate images of adults, but not children.",
+"Prevents the model from generating images of people."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions": {
+"description": "The image output format for generated images.",
+"id": "GoogleCloudAiplatformV1beta1ImageConfigImageOutputOptions",
+"properties": {
+"compressionQuality": {
+"description": "Optional. The compression quality of the output image.",
+"format": "int32",
+"type": "integer"
+},
+"mimeType": {
+"description": "Optional. The image format that the output should be saved as.",
+"type": "string"
 }
 },
 "type": "object"
@@ -40461,6 +50988,18 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1IntermediateExtractedMemory": {
+"description": "An extracted memory that is the intermediate result before consolidation.",
+"id": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory",
+"properties": {
+"fact": {
+"description": "Output only. The fact of the extracted memory.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance": {
 "description": "Request message for [InternalOsServiceStateInstance].",
 "id": "GoogleCloudAiplatformV1beta1InternalOsServiceStateInstance",
@@ -41230,6 +51769,24 @@
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse": {
+"description": "Response message for MemoryBankService.ListMemoryRevisions.",
+"id": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse",
+"properties": {
+"memoryRevisions": {
+"description": "The list of Memory Revisions in the request page.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1MemoryRevision"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse": {
 "description": "Response message for MetadataService.ListMetadataSchemas.",
 "id": "GoogleCloudAiplatformV1beta1ListMetadataSchemasResponse",
@@ -41862,18 +52419,18 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1LogprobsResult": {
-"description": "Logprobs Result",
+"description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.",
 "id": "GoogleCloudAiplatformV1beta1LogprobsResult",
 "properties": {
 "chosenCandidates": {
-"description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.",
+"description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate"
 },
 "type": "array"
 },
 "topCandidates": {
-"description": "Length = total number of decoding steps.",
+"description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates"
 },
@@ -41883,20 +52440,20 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": {
-"description": "Candidate for the logprobs token and score.",
+"description": "A single token and its associated log probability.",
 "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate",
 "properties": {
 "logProbability": {
-"description": "The candidate's log probability.",
+"description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.",
 "format": "float",
 "type": "number"
 },
 "token": {
-"description": "The candidate's token string value.",
+"description": "The token's string representation.",
 "type": "string"
 },
 "tokenId": {
-"description": "The candidate's token id value.",
+"description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.",
 "format": "int32",
 "type": "integer"
 }
@@ -41904,11 +52461,11 @@
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": {
-"description": "Candidates with top log probabilities at each decoding step.",
+"description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.",
 "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates",
 "properties": {
 "candidates": {
-"description": "Sorted by log probability in descending order.",
+"description": "The list of candidate tokens, sorted by log probability in descending order.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate"
 },
@@ -42122,6 +52679,10 @@ false
 "description": "Optional. Description of the Memory.",
 "type": "string"
 },
+"disableMemoryRevisions": {
+"description": "Optional. Input only. If true, no revision will be created for this request.",
+"type": "boolean"
+},
 "displayName": {
 "description": "Optional. Display name of the Memory.",
 "type": "string"
@@ -42139,6 +52700,23 @@ false
 "description": "Identifier. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`",
 "type": "string"
 },
+"revisionExpireTime": {
+"description": "Optional. Input only. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.",
+"format": "google-datetime",
+"type": "string"
+},
+"revisionLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Input only. The labels to apply to the Memory Revision created as a result of this request.",
+"type": "object"
+},
+"revisionTtl": {
+"description": "Optional. Input only. The TTL for the revision. The expiration time is computed: now + TTL.",
+"format": "google-duration",
+"type": "string"
+},
 "scope": {
 "additionalProperties": {
 "type": "string"
@@ -42146,6 +52724,13 @@ false
 "description": "Required. Immutable. The scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.",
 "type": "object"
 },
+"topics": {
+"description": "Optional. The Topics of the Memory.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId"
+},
+"type": "array"
+},
 "ttl": {
 "description": "Optional. Input only. The TTL for this resource. The expiration time is computed: now + TTL.",
 "format": "google-duration",
@@ -42304,6 +52889,50 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1MemoryRevision": {
+"description": "A revision of a Memory.",
+"id": "GoogleCloudAiplatformV1beta1MemoryRevision",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp when this Memory Revision was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"expireTime": {
+"description": "Output only. Timestamp of when this resource is considered expired.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"extractedMemories": {
+"description": "Output only. The extracted memories from the source content before consolidation when the memory was updated via GenerateMemories. This information was used to modify an existing Memory via Consolidation.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1IntermediateExtractedMemory"
+},
+"readOnly": true,
+"type": "array"
+},
+"fact": {
+"description": "Output only. The fact of the Memory Revision. This corresponds to the `fact` field of the parent Memory at the time of revision creation.",
+"readOnly": true,
+"type": "string"
+},
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Output only. The labels of the Memory Revision. These labels are applied to the MemoryRevision when it is created based on `GenerateMemoriesRequest.revision_labels`.",
+"readOnly": true,
+"type": "object"
+},
+"name": {
+"description": "Identifier. The resource name of the Memory Revision. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{memory_revision}`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1MemoryTopicId": {
 "description": "A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.",
 "id": "GoogleCloudAiplatformV1beta1MemoryTopicId",
@@ -42513,6 +53142,10 @@ false
 "$ref": "GoogleCloudAiplatformV1beta1BleuSpec",
 "description": "Spec for bleu metric."
 },
+"customCodeExecutionSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec",
+"description": "Spec for Custom Code Execution metric."
+},
 "exactMatchSpec": {
 "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec",
 "description": "Spec for exact match metric."
@@ -42895,11 +53528,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1ModalityTokenCount": {
-"description": "Represents token counting info for a single modality.",
+"description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.",
 "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount",
 "properties": {
 "modality": {
-"description": "The modality associated with this token count.",
+"description": "The modality that this token count applies to.",
 "enum": [
 "MODALITY_UNSPECIFIED",
 "TEXT",
@@ -42909,17 +53542,17 @@ false
 "DOCUMENT"
 ],
 "enumDescriptions": [
-"Unspecified modality.",
-"Plain text.",
-"Image.",
-"Video.",
-"Audio.",
-"Document, e.g. PDF."
+"When a modality is not specified, it is treated as `TEXT`.",
+"The `Part` contains plain text.",
+"The `Part` contains an image.",
+"The `Part` contains a video.",
+"The `Part` contains audio.",
+"The `Part` contains a document, such as a PDF."
 ],
 "type": "string"
 },
 "tokenCount": {
-"description": "Number of tokens.",
+"description": "The number of tokens counted for this modality.",
 "format": "int32",
 "type": "integer"
 }
@@ -43123,15 +53756,15 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1ModelArmorConfig": {
-"description": "Configuration for Model Armor integrations of prompt and responses.",
+"description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.",
 "id": "GoogleCloudAiplatformV1beta1ModelArmorConfig",
 "properties": {
 "promptTemplateName": {
-"description": "Optional. The name of the Model Armor template to use for prompt sanitization.",
+"description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.",
 "type": "string"
 },
 "responseTemplateName": {
-"description": "Optional. The name of the Model Armor template to use for response sanitization.",
+"description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.",
 "type": "string"
 }
 },
@@ -44896,7 +55529,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": {
-"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.",
+"description": "Configuration for a multi-speaker text-to-speech request.",
 "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig",
 "properties": {
 "speakerVoiceConfigs": {
@@ -44952,7 +55585,7 @@ false
 "properties": {
 "deployedModel": {
 "$ref": "GoogleCloudAiplatformV1beta1DeployedModel",
-"description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only)"
+"description": "Required. The DeployedModel to be mutated within the Endpoint. Only the following fields can be mutated: * `min_replica_count` in either DedicatedResources or AutomaticResources * `max_replica_count` in either DedicatedResources or AutomaticResources * `required_replica_count` in DedicatedResources * autoscaling_metric_specs * `disable_container_logging` (v1 only) * `enable_container_logging` (v1beta1 only) * `scale_to_zero_spec` in DedicatedResources (v1beta1 only) * `initial_replica_count` in DedicatedResources (v1beta1 only)"
 },
 "updateMask": {
 "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.",
@@ -46283,6 +56916,20 @@ false
 "content": {
 "$ref": "GoogleCloudAiplatformV1beta1Content",
 "description": "Required. The content to optimize."
+},
+"optimizationTarget": {
+"description": "Optional. The target model to optimize the prompt for.",
+"enum": [
+"OPTIMIZATION_TARGET_UNSPECIFIED",
+"OPTIMIZATION_TARGET_GENERAL",
+"OPTIMIZATION_TARGET_GEMINI_NANO"
+],
+"enumDescriptions": [
+"Unspecified optimization target. Default to OPTIMIZATION_TARGET_GENERAL.",
+"Optimize the prompt for quality.",
+"Optimize the prompt for Gemini Nano."
+],
+"type": "string"
 }
 },
 "type": "object"
@@ -46678,39 +57325,39 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1Part": {
-"description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
+"description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.",
 "id": "GoogleCloudAiplatformV1beta1Part",
 "properties": {
 "codeExecutionResult": {
 "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult",
-"description": "Optional. Result of executing the [ExecutableCode]."
+"description": "Optional. The result of executing the ExecutableCode."
 },
 "executableCode": {
 "$ref": "GoogleCloudAiplatformV1beta1ExecutableCode",
-"description": "Optional. Code generated by the model that is meant to be executed."
+"description": "Optional. Code generated by the model that is intended to be executed."
 },
 "fileData": {
 "$ref": "GoogleCloudAiplatformV1beta1FileData",
-"description": "Optional. URI based data."
+"description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage."
 },
 "functionCall": {
 "$ref": "GoogleCloudAiplatformV1beta1FunctionCall",
-"description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values."
+"description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function."
 },
 "functionResponse": {
 "$ref": "GoogleCloudAiplatformV1beta1FunctionResponse",
-"description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."
+"description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted."
 },
 "inlineData": {
 "$ref": "GoogleCloudAiplatformV1beta1Blob",
-"description": "Optional. Inlined bytes data."
+"description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request."
 },
 "text": {
-"description": "Optional. Text part (can be code).",
+"description": "Optional. The text content of the part.",
 "type": "string"
 },
 "thought": {
-"description": "Optional. Indicates if the part is thought from the model.",
+"description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.",
 "type": "boolean"
 },
 "thoughtSignature": {
@@ -47632,11 +58279,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": {
-"description": "The configuration for the prebuilt speaker to use.",
+"description": "Configuration for a prebuilt voice.",
 "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig",
 "properties": {
 "voiceName": {
-"description": "The name of the preset voice to use.",
+"description": "The name of the prebuilt voice to use.",
 "type": "string"
 }
 },
@@ -47718,6 +58365,13 @@ false
 },
 "type": "array"
 },
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The user labels for Imagen billing usage only. Only Imagen supports labels. For other use cases, it will be ignored.",
+"type": "object"
+},
 "parameters": {
 "description": "The parameters that govern the prediction. The schema of the parameters may be specified via Endpoint's DeployedModels' Model's PredictSchemata's parameters_schema_uri.",
 "type": "any"
@@ -47929,10 +58583,6 @@ false
 "description": "Tuning Spec for Preference Optimization.",
 "id": "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec",
 "properties": {
-"evaluationConfig": {
-"$ref": "GoogleCloudAiplatformV1beta1EvaluationConfig",
-"description": "Optional. Evaluation Config for Preference Optimization Job."
-},
 "exportLastCheckpointOnly": {
 "description": "Optional. If set to true, disable intermediate checkpoints for Preference Optimization and only the last checkpoint will be exported. Otherwise, enable intermediate checkpoints for Preference Optimization. Default is false.",
 "type": "boolean"
@@ -49367,6 +60017,16 @@ false
 "deprecated": true,
 "description": "Optional. Immutable. The Vector DB config of the RagCorpus."
 },
+"satisfiesPzi": {
+"description": "Output only. Reserved for future use.",
+"readOnly": true,
+"type": "boolean"
+},
+"satisfiesPzs": {
+"description": "Output only. Reserved for future use.",
+"readOnly": true,
+"type": "boolean"
+},
 "updateTime": {
 "description": "Output only. Timestamp when this RagCorpus was last updated.",
 "format": "google-datetime",
@@ -49778,11 +60438,11 @@ false
 "enterprise": {
 "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigEnterprise",
 "deprecated": true,
-"description": "Sets the RagManagedDb to the Enterprise tier. This is the default tier if not explicitly chosen."
+"description": "Sets the RagManagedDb to the Enterprise tier."
 },
 "scaled": {
 "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigScaled",
-"description": "Sets the RagManagedDb to the Scaled tier."
+"description": "Sets the RagManagedDb to the Scaled tier. This is the default tier if not explicitly chosen."
 },
 "unprovisioned": {
 "$ref": "GoogleCloudAiplatformV1beta1RagManagedDbConfigUnprovisioned",
@@ -50439,6 +61099,10 @@ false
 },
 "type": "array"
 },
+"disableMemoryRevisions": {
+"description": "If true, no memory revisions will be created for any requests to the Memory Bank.",
+"type": "boolean"
+},
 "generationConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigGenerationConfig",
 "description": "Optional. Configuration for how to generate memories for the Memory Bank."
@@ -50488,6 +61152,11 @@ false
 "granularTtlConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig",
 "description": "Optional. The granular TTL configuration of the memories in the Memory Bank."
+},
+"memoryRevisionDefaultTtl": {
+"description": "Optional. The default TTL duration of the memory revisions in the Memory Bank. This applies to all operations that create a memory revision. If not set, a default TTL of 365 days will be used.",
+"format": "google-duration",
+"type": "string"
 }
 },
 "type": "object"
@@ -50518,6 +61187,14 @@ false
 "description": "ReasoningEngine configurations",
 "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpec",
 "properties": {
+"agentCard": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. The A2A Agent Card for the agent (if available). It follows the specification at https://a2a-protocol.org/latest/specification/#5-agent-discovery-the-agent-card.",
+"type": "object"
+},
 "agentFramework": {
 "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".",
 "type": "string"
@@ -50544,6 +61221,10 @@ false
 "serviceAccount": {
 "description": "Optional. The service account that the Reasoning Engine artifact runs as. It should have \"roles/storage.objectViewer\" for reading the user project's Cloud Storage and \"roles/aiplatform.user\" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.",
 "type": "string"
+},
+"sourceCodeSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec",
+"description": "Deploy from source code files with a defined entrypoint."
 }
 },
 "type": "object"
@@ -50622,7 +61303,7 @@ false
 "type": "string"
 },
 "pythonVersion": {
-"description": "Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not specified, default value is 3.10.",
+"description": "Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, the default value is 3.10.",
 "type": "string"
 },
 "requirementsGcsUri": {
@@ -50632,6 +61313,56 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec": {
+"description": "Specification for deploying from source code.",
+"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpec",
+"properties": {
+"inlineSource": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource",
+"description": "Source code is provided directly in the request."
+},
+"pythonSpec": {
+"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec",
+"description": "Configuration for a Python application."
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource": {
+"description": "Specifies source code provided as a byte stream.",
+"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecInlineSource",
+"properties": {
+"sourceArchive": {
+"description": "Required. Input only. The application source code archive, provided as a compressed tarball (.tar.gz) file.",
+"format": "byte",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec": {
+"description": "Specification for running a Python application from source.",
+"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecSourceCodeSpecPythonSpec",
+"properties": {
+"entrypointModule": {
+"description": "Optional. The Python module to load as the entrypoint, specified as a fully qualified module name. For example: path.to.agent. If not specified, defaults to \"agent\". The project root will be added to Python sys.path, allowing imports to be specified relative to the root.",
+"type": "string"
+},
+"entrypointObject": {
+"description": "Optional. The name of the callable object within the `entrypoint_module` to use as the application If not specified, defaults to \"root_agent\".",
+"type": "string"
+},
+"requirementsFile": {
+"description": "Optional. The path to the requirements file, relative to the source root. If not specified, defaults to \"requirements.txt\".",
+"type": "string"
+},
+"version": {
+"description": "Optional. The version of Python to use. Support version includes 3.9, 3.10, 3.11, 3.12, 3.13. If not specified, default value is 3.10.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest": {
 "description": "Request message for GenAiTuningService.RebaseTunedModel.",
 "id": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest",
@@ -51140,11 +61871,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1RetrievalMetadata": {
-"description": "Metadata related to retrieval in the grounding flow.",
+"description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.",
 "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata",
 "properties": {
 "googleSearchDynamicRetrievalScore": {
-"description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.",
+"description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.",
 "format": "float",
 "type": "number"
 }
@@ -51227,6 +61958,10 @@ false
 "description": "Request message for MemoryBankService.RetrieveMemories.",
 "id": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest",
 "properties": {
+"filter": {
+"description": "Optional. The standard list filter that will be applied to the retrieved memories. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `fact` * `create_time` * `update_time`",
+"type": "string"
+},
 "scope": {
 "additionalProperties": {
 "type": "string"
@@ -51311,6 +62046,18 @@ false
 },
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1RollbackMemoryRequest": {
+"description": "Request message for MemoryBankService.RollbackMemory.",
+"id": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest",
+"properties": {
+"targetRevisionId": {
+"description": "Required. The ID of the revision to rollback to.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1RolloutOptions": {
 "description": "Configuration for rolling deployments.",
 "id": "GoogleCloudAiplatformV1beta1RolloutOptions",
@@ -51755,16 +62502,16 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1SafetyRating": {
-"description": "Safety rating corresponding to the generated content.",
+"description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.",
 "id": "GoogleCloudAiplatformV1beta1SafetyRating",
 "properties": {
 "blocked": {
-"description": "Output only. Indicates whether the content was filtered out because of this rating.",
+"description": "Output only. Indicates whether the content was blocked because of this rating.",
 "readOnly": true,
 "type": "boolean"
 },
 "category": {
-"description": "Output only. Harm category.",
+"description": "Output only. The harm category of this rating.",
 "enum": [
 "HARM_CATEGORY_UNSPECIFIED",
 "HARM_CATEGORY_HATE_SPEECH",
@@ -51792,17 +62539,17 @@ false,
 false
 ],
 "enumDescriptions": [
-"The harm category is unspecified.",
-"The harm category is hate speech.",
-"The harm category is dangerous content.",
-"The harm category is harassment.",
-"The harm category is sexually explicit content.",
+"Default value. This value is unused.",
+"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.",
+"Content that promotes, facilitates, or enables dangerous activities.",
+"Abusive, threatening, or content intended to bully, torment, or ridicule.",
+"Content that contains sexually explicit material.",
 "Deprecated: Election filter is not longer supported. The harm category is civic integrity.",
-"The harm category is image hate.",
-"The harm category is image dangerous content.",
-"The harm category is image harassment.",
-"The harm category is image sexually explicit content.",
-"The harm category is for jailbreak prompts."
+"Images that contain hate speech.",
+"Images that contain dangerous content.",
+"Images that contain harassment.",
+"Images that contain sexually explicit content.",
+"Prompts designed to bypass safety filters."
 ],
 "readOnly": true,
 "type": "string"
@@ -51818,18 +62565,18 @@ false
 "OFF"
 ],
 "enumDescriptions": [
-"Unspecified harm block threshold.",
-"Block low threshold and above (i.e. block more).",
-"Block medium threshold and above.",
-"Block only high threshold (i.e. block less).",
-"Block none.",
-"Turn off the safety filter."
+"The harm block threshold is unspecified.",
+"Block content with a low harm probability or higher.",
+"Block content with a medium harm probability or higher.",
+"Block content with a high harm probability.",
+"Do not block any content, regardless of its harm probability.",
+"Turn off the safety filter entirely."
 ],
 "readOnly": true,
 "type": "string"
 },
 "probability": {
-"description": "Output only. Harm probability levels in the content.",
+"description": "Output only. The probability of harm for this category.",
 "enum": [
 "HARM_PROBABILITY_UNSPECIFIED",
 "NEGLIGIBLE",
@@ -51838,23 +62585,23 @@ false
 "HIGH"
 ],
 "enumDescriptions": [
-"Harm probability unspecified.",
-"Negligible level of harm.",
-"Low level of harm.",
-"Medium level of harm.",
-"High level of harm."
+"The harm probability is unspecified.",
+"The harm probability is negligible.",
+"The harm probability is low.",
+"The harm probability is medium.",
+"The harm probability is high."
 ],
 "readOnly": true,
 "type": "string"
 },
 "probabilityScore": {
-"description": "Output only. Harm probability score.",
+"description": "Output only. The probability score of harm for this category.",
 "format": "float",
 "readOnly": true,
 "type": "number"
 },
 "severity": {
-"description": "Output only. Harm severity levels in the content.",
+"description": "Output only. The severity of harm for this category.",
 "enum": [
 "HARM_SEVERITY_UNSPECIFIED",
 "HARM_SEVERITY_NEGLIGIBLE",
@@ -51863,17 +62610,17 @@ false
 "HARM_SEVERITY_HIGH"
 ],
 "enumDescriptions": [
-"Harm severity unspecified.",
-"Negligible level of harm severity.",
-"Low level of harm severity.",
-"Medium level of harm severity.",
-"High level of harm severity."
+"The harm severity is unspecified.",
+"The harm severity is negligible.",
+"The harm severity is low.",
+"The harm severity is medium.",
+"The harm severity is high."
 ],
 "readOnly": true,
 "type": "string"
 },
 "severityScore": {
-"description": "Output only. Harm severity score.",
+"description": "Output only. The severity score of harm for this category.",
 "format": "float",
 "readOnly": true,
 "type": "number"
@@ -51906,11 +62653,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1SafetySetting": {
-"description": "Safety settings.",
+"description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.",
 "id": "GoogleCloudAiplatformV1beta1SafetySetting",
 "properties": {
 "category": {
-"description": "Required. Harm category.",
+"description": "Required. The harm category to be blocked.",
 "enum": [
 "HARM_CATEGORY_UNSPECIFIED",
 "HARM_CATEGORY_HATE_SPEECH",
@@ -51938,22 +62685,22 @@ false,
 false
 ],
 "enumDescriptions": [
-"The harm category is unspecified.",
-"The harm category is hate speech.",
-"The harm category is dangerous content.",
-"The harm category is harassment.",
-"The harm category is sexually explicit content.",
+"Default value. This value is unused.",
+"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.",
+"Content that promotes, facilitates, or enables dangerous activities.",
+"Abusive, threatening, or content intended to bully, torment, or ridicule.",
+"Content that contains sexually explicit material.",
 "Deprecated: Election filter is not longer supported. The harm category is civic integrity.",
-"The harm category is image hate.",
-"The harm category is image dangerous content.",
-"The harm category is image harassment.",
-"The harm category is image sexually explicit content.",
-"The harm category is for jailbreak prompts."
+"Images that contain hate speech.",
+"Images that contain dangerous content.",
+"Images that contain harassment.",
+"Images that contain sexually explicit content.",
+"Prompts designed to bypass safety filters."
 ],
 "type": "string"
 },
 "method": {
-"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.",
+"description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.",
 "enum": [
 "HARM_BLOCK_METHOD_UNSPECIFIED",
 "SEVERITY",
@@ -51967,7 +62714,7 @@ false
 "type": "string"
 },
 "threshold": {
-"description": "Required. The harm block threshold.",
+"description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.",
 "enum": [
 "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
 "BLOCK_LOW_AND_ABOVE",
@@ -51977,12 +62724,12 @@ false
 "OFF"
 ],
 "enumDescriptions": [
-"Unspecified harm block threshold.",
-"Block low threshold and above (i.e. block more).",
-"Block medium threshold and above.",
-"Block only high threshold (i.e. block less).",
-"Block none.",
-"Turn off the safety filter."
+"The harm block threshold is unspecified.",
+"Block content with a low harm probability or higher.",
+"Block content with a medium harm probability or higher.",
+"Block content with a high harm probability.",
+"Do not block any content, regardless of its harm probability.",
+"Turn off the safety filter entirely."
 ],
 "type": "string"
 }
@@ -56745,15 +67492,15 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1SearchEntryPoint": {
-"description": "Google search entry point.",
+"description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.",
 "id": "GoogleCloudAiplatformV1beta1SearchEntryPoint",
 "properties": {
 "renderedContent": {
-"description": "Optional. Web content snippet that can be embedded in a web page or an app webview.",
+"description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.",
 "type": "string"
 },
 "sdkBlob": {
-"description": "Optional. Base64 encoded JSON representing array of tuple.",
+"description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.",
 "format": "byte",
 "type": "string"
 }
@@ -57142,29 +67889,29 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1Segment": {
-"description": "Segment of the content.",
+"description": "A segment of the content.",
 "id": "GoogleCloudAiplatformV1beta1Segment",
 "properties": {
 "endIndex": {
-"description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.",
+"description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "partIndex": {
-"description": "Output only. The index of a Part object within its parent Content object.",
+"description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "startIndex": {
-"description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.",
+"description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.",
 "format": "int32",
 "readOnly": true,
 "type": "integer"
 },
 "text": {
-"description": "Output only. The text corresponding to the segment from the response.",
+"description": "Output only. The text of the segment.",
 "readOnly": true,
 "type": "string"
 }
@@ -57434,7 +68181,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": {
-"description": "Configuration for a single speaker in a multi speaker setup.",
+"description": "Configuration for a single speaker in a multi-speaker setup.",
 "id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig",
 "properties": {
 "speaker": {
@@ -57535,11 +68282,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1SpeechConfig": {
-"description": "The speech generation config.",
+"description": "Configuration for speech generation.",
 "id": "GoogleCloudAiplatformV1beta1SpeechConfig",
 "properties": {
 "languageCode": {
-"description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.",
+"description": "Optional. The language code (ISO 639-1) for the speech synthesis.",
 "type": "string"
 },
 "multiSpeakerVoiceConfig": {
@@ -57548,7 +68295,7 @@ false
 },
 "voiceConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig",
-"description": "The configuration for the speaker to use."
+"description": "The configuration for the voice to use."
 }
 },
 "type": "object"
@@ -59664,6 +70411,10 @@ false
 "$ref": "GoogleCloudAiplatformV1beta1ToolCodeExecution",
 "description": "Optional. CodeExecution tool type. Enables the model to execute code as part of generation."
 },
+"computerUse": {
+"$ref": "GoogleCloudAiplatformV1beta1ToolComputerUse",
+"description": "Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations."
+},
 "enterpriseWebSearch": {
 "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch",
 "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance."
@@ -59787,6 +70538,32 @@ false
 "properties": {},
 "type": "object"
 },
+"GoogleCloudAiplatformV1beta1ToolComputerUse": {
+"description": "Tool to support computer use.",
+"id": "GoogleCloudAiplatformV1beta1ToolComputerUse",
+"properties": {
+"environment": {
+"description": "Required. The environment being operated.",
+"enum": [
+"ENVIRONMENT_UNSPECIFIED",
+"ENVIRONMENT_BROWSER"
+],
+"enumDescriptions": [
+"Defaults to browser.",
+"Operates in a web browser."
+],
+"type": "string"
+},
+"excludedPredefinedFunctions": {
+"description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudAiplatformV1beta1ToolConfig": {
 "description": "Tool config. This config is shared for all tools provided in the request.",
 "id": "GoogleCloudAiplatformV1beta1ToolConfig",
@@ -61540,11 +72317,11 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1UrlContextMetadata": {
-"description": "Metadata related to url context retrieval tool.",
+"description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.",
 "id": "GoogleCloudAiplatformV1beta1UrlContextMetadata",
 "properties": {
 "urlMetadata": {
-"description": "Output only. List of url context.",
+"description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.",
 "items": {
 "$ref": "GoogleCloudAiplatformV1beta1UrlMetadata"
 },
@@ -61555,15 +72332,15 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1UrlMetadata": {
-"description": "Context of the a single url retrieval.",
+"description": "The metadata for a single URL retrieval.",
 "id": "GoogleCloudAiplatformV1beta1UrlMetadata",
 "properties": {
 "retrievedUrl": {
-"description": "Retrieved url by the tool.",
+"description": "The URL retrieved by the tool.",
 "type": "string"
 },
 "urlRetrievalStatus": {
-"description": "Status of the url retrieval.",
+"description": "The status of the URL retrieval.",
 "enum": [
 "URL_RETRIEVAL_STATUS_UNSPECIFIED",
 "URL_RETRIEVAL_STATUS_SUCCESS",
@@ -61571,9 +72348,96 @@ false
 ],
 "enumDescriptions": [
 "Default value. This value is unused.",
-"Url retrieval is successful.",
-"Url retrieval is failed due to error."
+"The URL was retrieved successfully.",
+"The URL retrieval failed."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudAiplatformV1beta1UsageMetadata": {
+"description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.",
+"id": "GoogleCloudAiplatformV1beta1UsageMetadata",
+"properties": {
+"cacheTokensDetails": {
+"description": "Output only. A detailed breakdown of the token count for each modality in the cached content.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"cachedContentTokenCount": {
+"description": "Output only. The number of tokens in the cached content that was used for this request.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"candidatesTokenCount": {
+"description": "The total number of tokens in the generated candidates.",
+"format": "int32",
+"type": "integer"
+},
+"candidatesTokensDetails": {
+"description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"promptTokenCount": {
+"description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.",
+"format": "int32",
+"type": "integer"
+},
+"promptTokensDetails": {
+"description": "Output only. A detailed breakdown of the token count for each modality in the prompt.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"thoughtsTokenCount": {
+"description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"toolUsePromptTokenCount": {
+"description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"toolUsePromptTokensDetails": {
+"description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.",
+"items": {
+"$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount"
+},
+"readOnly": true,
+"type": "array"
+},
+"totalTokenCount": {
+"description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.",
+"format": "int32",
+"type": "integer"
+},
+"trafficType": {
+"description": "Output only. The traffic type for this request.",
+"enum": [
+"TRAFFIC_TYPE_UNSPECIFIED",
+"ON_DEMAND",
+"PROVISIONED_THROUGHPUT"
+],
+"enumDescriptions": [
+"Unspecified request traffic type.",
+"Type for Pay-As-You-Go traffic.",
+"Type for Provisioned Throughput traffic."
 ],
+"readOnly": true,
 "type": "string"
 }
 },
@@ -61789,7 +72653,7 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1VideoMetadata": {
-"description": "Metadata describes the input video content.",
+"description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.",
 "id": "GoogleCloudAiplatformV1beta1VideoMetadata",
 "properties": {
 "endOffset": {
@@ -61798,7 +72662,7 @@ false
 "type": "string"
 },
 "fps": {
-"description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].",
+"description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].",
 "format": "double",
 "type": "number"
 },
@@ -61811,12 +72675,12 @@ false
 "type": "object"
 },
 "GoogleCloudAiplatformV1beta1VoiceConfig": {
-"description": "The configuration for the voice to use.",
+"description": "Configuration for a voice.",
 "id": "GoogleCloudAiplatformV1beta1VoiceConfig",
 "properties": {
 "prebuiltVoiceConfig": {
 "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig",
-"description": "The configuration for the prebuilt voice to use."
+"description": "The configuration for a prebuilt voice."
 }
 },
 "type": "object"

From 8c341070f77639ef47f010d9410a814d65f0ed1e Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:09 +0000
Subject: [PATCH 04/70] feat(alloydb): update the api

#### alloydb:v1

The following keys were added:
- schemas.Cluster.properties.dataplexConfig.$ref (Total Keys: 1)
- schemas.DataplexConfig (Total Keys: 3)

#### alloydb:v1alpha

The following keys were added:
- schemas.Cluster.properties.dataplexConfig.$ref (Total Keys: 1)
- schemas.DataplexConfig (Total Keys: 3)

#### alloydb:v1beta

The following keys were added:
- schemas.Cluster.properties.dataplexConfig.$ref (Total Keys: 1)
- schemas.DataplexConfig (Total Keys: 3)
---
 ...lloydb_v1.projects.locations.clusters.html | 21 +++++++++
 docs/dyn/alloydb_v1.projects.locations.html   |  2 +-
 ...b_v1alpha.projects.locations.clusters.html | 21 +++++++++
 .../alloydb_v1alpha.projects.locations.html   |  2 +-
 ...db_v1beta.projects.locations.clusters.html | 21 +++++++++
 .../alloydb_v1beta.projects.locations.html    |  2 +-
 .../discovery_cache/documents/alloydb.v1.json | 45 ++++++++++++++-----
 .../documents/alloydb.v1alpha.json            | 45 ++++++++++++++-----
 .../documents/alloydb.v1beta.json             | 45 ++++++++++++++-----
 9 files changed, 171 insertions(+), 33 deletions(-)

diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.html b/docs/dyn/alloydb_v1.projects.locations.clusters.html
index 540d05d7da..4de1e62a00 100644
--- a/docs/dyn/alloydb_v1.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1.projects.locations.clusters.html
@@ -239,6 +239,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -474,6 +477,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -817,6 +823,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1087,6 +1096,9 @@ 
Method Details

       },
       "createTime": "A String", # Output only. Create time stamp
       "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+      "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+        "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+      },
       "deleteTime": "A String", # Output only. Delete time stamp
       "displayName": "A String", # User-settable and human-readable display name for the Cluster.
       "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1311,6 +1323,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1603,6 +1618,9 @@ 
Method Details

     },
     "createTime": "A String", # Output only. Create time stamp
     "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+    "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+      "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+    },
     "deleteTime": "A String", # Output only. Delete time stamp
     "displayName": "A String", # User-settable and human-readable display name for the Cluster.
     "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1849,6 +1867,9 @@ 
Method Details

     },
     "createTime": "A String", # Output only. Create time stamp
     "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+    "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+      "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+    },
     "deleteTime": "A String", # Output only. Delete time stamp
     "displayName": "A String", # User-settable and human-readable display name for the Cluster.
     "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
diff --git a/docs/dyn/alloydb_v1.projects.locations.html b/docs/dyn/alloydb_v1.projects.locations.html
index 163bb541f0..84a81a23ed 100644
--- a/docs/dyn/alloydb_v1.projects.locations.html
+++ b/docs/dyn/alloydb_v1.projects.locations.html
@@ -145,7 +145,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
index 9cebe06928..1bf7d06d4e 100644
--- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html
@@ -239,6 +239,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -480,6 +483,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -829,6 +835,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1105,6 +1114,9 @@ 
Method Details

       },
       "createTime": "A String", # Output only. Create time stamp
       "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+      "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+        "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+      },
       "deleteTime": "A String", # Output only. Delete time stamp
       "displayName": "A String", # User-settable and human-readable display name for the Cluster.
       "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1335,6 +1347,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1633,6 +1648,9 @@ 
Method Details

     },
     "createTime": "A String", # Output only. Create time stamp
     "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+    "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+      "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+    },
     "deleteTime": "A String", # Output only. Delete time stamp
     "displayName": "A String", # User-settable and human-readable display name for the Cluster.
     "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1885,6 +1903,9 @@ 
Method Details

     },
     "createTime": "A String", # Output only. Create time stamp
     "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+    "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+      "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+    },
     "deleteTime": "A String", # Output only. Delete time stamp
     "displayName": "A String", # User-settable and human-readable display name for the Cluster.
     "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.html b/docs/dyn/alloydb_v1alpha.projects.locations.html
index f995e6090b..2234500c30 100644
--- a/docs/dyn/alloydb_v1alpha.projects.locations.html
+++ b/docs/dyn/alloydb_v1alpha.projects.locations.html
@@ -145,7 +145,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
index 48dcd8de90..cde8c41312 100644
--- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
+++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html
@@ -239,6 +239,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -479,6 +482,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -827,6 +833,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1102,6 +1111,9 @@ 
Method Details

       },
       "createTime": "A String", # Output only. Create time stamp
       "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+      "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+        "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+      },
       "deleteTime": "A String", # Output only. Delete time stamp
       "displayName": "A String", # User-settable and human-readable display name for the Cluster.
       "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1331,6 +1343,9 @@ 
Method Details

   },
   "createTime": "A String", # Output only. Create time stamp
   "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+  "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+    "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+  },
   "deleteTime": "A String", # Output only. Delete time stamp
   "displayName": "A String", # User-settable and human-readable display name for the Cluster.
   "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1628,6 +1643,9 @@ 
Method Details

     },
     "createTime": "A String", # Output only. Create time stamp
     "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+    "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+      "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+    },
     "deleteTime": "A String", # Output only. Delete time stamp
     "displayName": "A String", # User-settable and human-readable display name for the Cluster.
     "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
@@ -1879,6 +1897,9 @@ 
Method Details

     },
     "createTime": "A String", # Output only. Create time stamp
     "databaseVersion": "A String", # Optional. The database engine major version. This is an optional field and it is populated at the Cluster creation time. If a database version is not supplied at cluster creation time, then a default database version will be used.
+    "dataplexConfig": { # Configuration for Dataplex integration. # Optional. Configuration for Dataplex integration.
+      "enabled": True or False, # Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex."
+    },
     "deleteTime": "A String", # Output only. Delete time stamp
     "displayName": "A String", # User-settable and human-readable display name for the Cluster.
     "encryptionConfig": { # EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). # Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.
diff --git a/docs/dyn/alloydb_v1beta.projects.locations.html b/docs/dyn/alloydb_v1beta.projects.locations.html
index 6979f2b817..7a5ea1573b 100644
--- a/docs/dyn/alloydb_v1beta.projects.locations.html
+++ b/docs/dyn/alloydb_v1beta.projects.locations.html
@@ -145,7 +145,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json
index 11e3a58fd8..f4fe319d44 100644
--- a/googleapiclient/discovery_cache/documents/alloydb.v1.json
+++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1627,7 +1627,7 @@
 }
 }
 },
-"revision": "20251009",
+"revision": "20251023",
 "rootUrl": "https://alloydb.googleapis.com/",
 "schemas": {
 "AuthorizedNetwork": {
@@ -2141,6 +2141,10 @@ false
 ],
 "type": "string"
 },
+"dataplexConfig": {
+"$ref": "DataplexConfig",
+"description": "Optional. Configuration for Dataplex integration."
+},
 "deleteTime": {
 "description": "Output only. Delete time stamp",
 "format": "google-datetime",
@@ -2581,6 +2585,17 @@ false
 },
 "type": "object"
 },
+"DataplexConfig": {
+"description": "Configuration for Dataplex integration.",
+"id": "DataplexConfig",
+"properties": {
+"enabled": {
+"description": "Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex.\"",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "DenyMaintenancePeriod": {
 "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.",
 "id": "DenyMaintenancePeriod",
@@ -4341,7 +4356,8 @@ false
 "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
 "SIGNAL_TYPE_NO_ROOT_PASSWORD",
 "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
-"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"
+"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDescriptions": [
 "Unspecified signal type.",
@@ -4349,7 +4365,8 @@ false
 "Represents database auditing is disabled.",
 "Represents if a database has a password configured for the root account or not.",
 "Represents if a resource is exposed to public access.",
-"Represents if a resources requires all incoming connections to use SSL or not."
+"Represents if a resources requires all incoming connections to use SSL or not.",
+"Represents if a resource version is in extended support."
 ],
 "type": "string"
 }
@@ -4657,7 +4674,8 @@ false
 "SIGNAL_TYPE_OUTDATED_VERSION",
 "SIGNAL_TYPE_OUTDATED_CLIENT",
 "SIGNAL_TYPE_DATABOOST_DISABLED",
-"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES"
+"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDeprecated": [
 false,
@@ -4763,6 +4781,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4869,7 +4888,8 @@ false
 "Outdated version.",
 "Outdated client.",
 "Databoost is disabled.",
-"Recommended maintenance policy."
+"Recommended maintenance policy.",
+"Resource version is in extended support."
 ],
 "type": "string"
 },
@@ -5309,7 +5329,8 @@ false
 "SIGNAL_TYPE_OUTDATED_VERSION",
 "SIGNAL_TYPE_OUTDATED_CLIENT",
 "SIGNAL_TYPE_DATABOOST_DISABLED",
-"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES"
+"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDeprecated": [
 false,
@@ -5415,6 +5436,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5521,7 +5543,8 @@ false
 "Outdated version.",
 "Outdated client.",
 "Databoost is disabled.",
-"Recommended maintenance policy."
+"Recommended maintenance policy.",
+"Resource version is in extended support."
 ],
 "type": "string"
 }
@@ -5574,7 +5597,8 @@ false
 "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
 "SIGNAL_TYPE_NO_ROOT_PASSWORD",
 "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
-"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"
+"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDescriptions": [
 "Unspecified signal type.",
@@ -5582,7 +5606,8 @@ false
 "Represents database auditing is disabled.",
 "Represents if a database has a password configured for the root account or not.",
 "Represents if a resource is exposed to public access.",
-"Represents if a resources requires all incoming connections to use SSL or not."
+"Represents if a resources requires all incoming connections to use SSL or not.",
+"Represents if a resource version is in extended support."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json
index 5f8cd92219..a89a8d6f85 100644
--- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1627,7 +1627,7 @@
 }
 }
 },
-"revision": "20251009",
+"revision": "20251023",
 "rootUrl": "https://alloydb.googleapis.com/",
 "schemas": {
 "AuthorizedNetwork": {
@@ -2164,6 +2164,10 @@ false
 ],
 "type": "string"
 },
+"dataplexConfig": {
+"$ref": "DataplexConfig",
+"description": "Optional. Configuration for Dataplex integration."
+},
 "deleteTime": {
 "description": "Output only. Delete time stamp",
 "format": "google-datetime",
@@ -2725,6 +2729,17 @@ false
 },
 "type": "object"
 },
+"DataplexConfig": {
+"description": "Configuration for Dataplex integration.",
+"id": "DataplexConfig",
+"properties": {
+"enabled": {
+"description": "Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex.\"",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "DenyMaintenancePeriod": {
 "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.",
 "id": "DenyMaintenancePeriod",
@@ -4601,7 +4616,8 @@ false
 "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
 "SIGNAL_TYPE_NO_ROOT_PASSWORD",
 "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
-"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"
+"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDescriptions": [
 "Unspecified signal type.",
@@ -4609,7 +4625,8 @@ false
 "Represents database auditing is disabled.",
 "Represents if a database has a password configured for the root account or not.",
 "Represents if a resource is exposed to public access.",
-"Represents if a resources requires all incoming connections to use SSL or not."
+"Represents if a resources requires all incoming connections to use SSL or not.",
+"Represents if a resource version is in extended support."
 ],
 "type": "string"
 }
@@ -4917,7 +4934,8 @@ false
 "SIGNAL_TYPE_OUTDATED_VERSION",
 "SIGNAL_TYPE_OUTDATED_CLIENT",
 "SIGNAL_TYPE_DATABOOST_DISABLED",
-"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES"
+"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDeprecated": [
 false,
@@ -5023,6 +5041,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5129,7 +5148,8 @@ false
 "Outdated version.",
 "Outdated client.",
 "Databoost is disabled.",
-"Recommended maintenance policy."
+"Recommended maintenance policy.",
+"Resource version is in extended support."
 ],
 "type": "string"
 },
@@ -5569,7 +5589,8 @@ false
 "SIGNAL_TYPE_OUTDATED_VERSION",
 "SIGNAL_TYPE_OUTDATED_CLIENT",
 "SIGNAL_TYPE_DATABOOST_DISABLED",
-"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES"
+"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDeprecated": [
 false,
@@ -5675,6 +5696,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5781,7 +5803,8 @@ false
 "Outdated version.",
 "Outdated client.",
 "Databoost is disabled.",
-"Recommended maintenance policy."
+"Recommended maintenance policy.",
+"Resource version is in extended support."
 ],
 "type": "string"
 }
@@ -5834,7 +5857,8 @@ false
 "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
 "SIGNAL_TYPE_NO_ROOT_PASSWORD",
 "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
-"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"
+"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDescriptions": [
 "Unspecified signal type.",
@@ -5842,7 +5866,8 @@ false
 "Represents database auditing is disabled.",
 "Represents if a database has a password configured for the root account or not.",
 "Represents if a resource is exposed to public access.",
-"Represents if a resources requires all incoming connections to use SSL or not."
+"Represents if a resources requires all incoming connections to use SSL or not.",
+"Represents if a resource version is in extended support."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
index 0f0ef39a62..c90131c481 100644
--- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1624,7 +1624,7 @@
 }
 }
 },
-"revision": "20251009",
+"revision": "20251023",
 "rootUrl": "https://alloydb.googleapis.com/",
 "schemas": {
 "AuthorizedNetwork": {
@@ -2150,6 +2150,10 @@ false
 ],
 "type": "string"
 },
+"dataplexConfig": {
+"$ref": "DataplexConfig",
+"description": "Optional. Configuration for Dataplex integration."
+},
 "deleteTime": {
 "description": "Output only. Delete time stamp",
 "format": "google-datetime",
@@ -2706,6 +2710,17 @@ false
 },
 "type": "object"
 },
+"DataplexConfig": {
+"description": "Configuration for Dataplex integration.",
+"id": "DataplexConfig",
+"properties": {
+"enabled": {
+"description": "Dataplex is enabled by default for resources such as clusters and instances. This flag controls the integration of AlloyDB PG resources (like databases, schemas, and tables) with Dataplex.\"",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "DenyMaintenancePeriod": {
 "description": "DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.",
 "id": "DenyMaintenancePeriod",
@@ -4577,7 +4592,8 @@ false
 "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
 "SIGNAL_TYPE_NO_ROOT_PASSWORD",
 "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
-"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"
+"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDescriptions": [
 "Unspecified signal type.",
@@ -4585,7 +4601,8 @@ false
 "Represents database auditing is disabled.",
 "Represents if a database has a password configured for the root account or not.",
 "Represents if a resource is exposed to public access.",
-"Represents if a resources requires all incoming connections to use SSL or not."
+"Represents if a resources requires all incoming connections to use SSL or not.",
+"Represents if a resource version is in extended support."
 ],
 "type": "string"
 }
@@ -4893,7 +4910,8 @@ false
 "SIGNAL_TYPE_OUTDATED_VERSION",
 "SIGNAL_TYPE_OUTDATED_CLIENT",
 "SIGNAL_TYPE_DATABOOST_DISABLED",
-"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES"
+"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDeprecated": [
 false,
@@ -4999,6 +5017,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5105,7 +5124,8 @@ false
 "Outdated version.",
 "Outdated client.",
 "Databoost is disabled.",
-"Recommended maintenance policy."
+"Recommended maintenance policy.",
+"Resource version is in extended support."
 ],
 "type": "string"
 },
@@ -5545,7 +5565,8 @@ false
 "SIGNAL_TYPE_OUTDATED_VERSION",
 "SIGNAL_TYPE_OUTDATED_CLIENT",
 "SIGNAL_TYPE_DATABOOST_DISABLED",
-"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES"
+"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDeprecated": [
 false,
@@ -5651,6 +5672,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5757,7 +5779,8 @@ false
 "Outdated version.",
 "Outdated client.",
 "Databoost is disabled.",
-"Recommended maintenance policy."
+"Recommended maintenance policy.",
+"Resource version is in extended support."
 ],
 "type": "string"
 }
@@ -5810,7 +5833,8 @@ false
 "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED",
 "SIGNAL_TYPE_NO_ROOT_PASSWORD",
 "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS",
-"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS"
+"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS",
+"SIGNAL_TYPE_EXTENDED_SUPPORT"
 ],
 "enumDescriptions": [
 "Unspecified signal type.",
@@ -5818,7 +5842,8 @@ false
 "Represents database auditing is disabled.",
 "Represents if a database has a password configured for the root account or not.",
 "Represents if a resource is exposed to public access.",
-"Represents if a resources requires all incoming connections to use SSL or not."
+"Represents if a resources requires all incoming connections to use SSL or not.",
+"Represents if a resource version is in extended support."
 ],
 "type": "string"
 }

From 9ba4beb4e61873283345d197c2909259948c5488 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:09 +0000
Subject: [PATCH 05/70] feat(analyticshub): update the api

#### analyticshub:v1

The following keys were added:
- schemas.GooglePubsubV1Subscription.properties.tags (Total Keys: 2)
- schemas.Listing.properties.storedProcedureConfig.$ref (Total Keys: 1)
- schemas.StoredProcedureConfig (Total Keys: 6)
---
 ...ects.locations.dataExchanges.listings.html | 39 ++++++++++++++++++
 .../documents/analyticshub.v1.json            | 40 ++++++++++++++++++-
 2 files changed, 78 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
index ef329a7913..2d265a45bd 100644
--- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
+++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html
@@ -193,6 +193,12 @@ 
Method Details

     "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table.
   },
   "state": "A String", # Output only. Current state of the listing.
+  "storedProcedureConfig": { # Stored procedure configuration, used to configure stored procedure sharing on linked dataset. # Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset.
+    "allowedStoredProcedureTypes": [ # Output only. Types of stored procedure supported to share.
+      "A String",
+    ],
+    "enabled": True or False, # Optional. If true, enable sharing of stored procedure.
+  },
 }
 
   listingId: string, Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Max length: 100 bytes.
@@ -269,6 +275,12 @@ 
Method Details

     "restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table.
   },
   "state": "A String", # Output only. Current state of the listing.
+  "storedProcedureConfig": { # Stored procedure configuration, used to configure stored procedure sharing on linked dataset. # Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset.
+    "allowedStoredProcedureTypes": [ # Output only. Types of stored procedure supported to share.
+      "A String",
+    ],
+    "enabled": True or False, # Optional. If true, enable sharing of stored procedure.
+  },
 }
@@ -370,6 +382,12 @@

Method Details

"restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. }, "state": "A String", # Output only. Current state of the listing. + "storedProcedureConfig": { # Stored procedure configuration, used to configure stored procedure sharing on linked dataset. # Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset. + "allowedStoredProcedureTypes": [ # Output only. Types of stored procedure supported to share. + "A String", + ], + "enabled": True or False, # Optional. If true, enable sharing of stored procedure. + }, } @@ -512,6 +530,12 @@

Method Details

"restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. }, "state": "A String", # Output only. Current state of the listing. + "storedProcedureConfig": { # Stored procedure configuration, used to configure stored procedure sharing on linked dataset. # Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset. + "allowedStoredProcedureTypes": [ # Output only. Types of stored procedure supported to share. + "A String", + ], + "enabled": True or False, # Optional. If true, enable sharing of stored procedure. + }, }, ], "nextPageToken": "A String", # A token to request the next page of results. @@ -691,6 +715,12 @@

Method Details

"restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. }, "state": "A String", # Output only. Current state of the listing. + "storedProcedureConfig": { # Stored procedure configuration, used to configure stored procedure sharing on linked dataset. # Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset. + "allowedStoredProcedureTypes": [ # Output only. Types of stored procedure supported to share. + "A String", + ], + "enabled": True or False, # Optional. If true, enable sharing of stored procedure. + }, } updateMask: string, Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request. @@ -767,6 +797,12 @@

Method Details

"restrictQueryResult": True or False, # Optional. If true, restrict export of query result derived from restricted linked dataset table. }, "state": "A String", # Output only. Current state of the listing. + "storedProcedureConfig": { # Stored procedure configuration, used to configure stored procedure sharing on linked dataset. # Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset. + "allowedStoredProcedureTypes": [ # Output only. Types of stored procedure supported to share. + "A String", + ], + "enabled": True or False, # Optional. If true, enable sharing of stored procedure. + }, } @@ -953,6 +989,9 @@

Method Details

"maximumBackoff": "A String", # Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, }, }, } diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 845647c5df..d17b891954 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1247,7 +1247,7 @@ } } }, -"revision": "20250901", +"revision": "20251020", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "ApproveQueryTemplateRequest": { @@ -1837,6 +1837,13 @@ "retryPolicy": { "$ref": "RetryPolicy", "description": "Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message." +}, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" } }, "type": "object" @@ -2147,6 +2154,10 @@ ], "readOnly": true, "type": "string" +}, +"storedProcedureConfig": { +"$ref": "StoredProcedureConfig", +"description": "Optional. If set, stored procedure configuration will be propagated and enforced on the linked dataset." } }, "type": "object" @@ -2669,6 +2680,33 @@ }, "type": "object" }, +"StoredProcedureConfig": { +"description": "Stored procedure configuration, used to configure stored procedure sharing on linked dataset.", +"id": "StoredProcedureConfig", +"properties": { +"allowedStoredProcedureTypes": { +"description": "Output only. Types of stored procedure supported to share.", +"items": { +"enum": [ +"STORED_PROCEDURE_TYPE_UNSPECIFIED", +"SQL_PROCEDURE" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"SQL stored procedure." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"enabled": { +"description": "Optional. If true, enable sharing of stored procedure.", +"type": "boolean" +} +}, +"type": "object" +}, "SubmitQueryTemplateRequest": { "description": "Message for submitting a QueryTemplate.", "id": "SubmitQueryTemplateRequest", From 3db77266c2abb44ab149d0f83f58f87727280274 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:09 +0000 Subject: [PATCH 06/70] feat(androidpublisher): update the api #### androidpublisher:v3 The following keys were added: - schemas.OneTimePurchaseDetails.properties.preorderDetails.$ref (Total Keys: 1) - schemas.PreorderDetails (Total Keys: 2) - schemas.PreorderOfferDetails (Total Keys: 4) - schemas.ProductOfferDetails.properties.preorderOfferDetails.$ref (Total Keys: 1) --- docs/dyn/androidpublisher_v3.orders.html | 4 +++ ...roidpublisher_v3.purchases.productsv2.html | 3 ++ .../documents/androidpublisher.v3.json | 34 +++++++++++++++++-- 3 files changed, 38 insertions(+), 3 deletions(-) diff --git a/docs/dyn/androidpublisher_v3.orders.html b/docs/dyn/androidpublisher_v3.orders.html index d04339caba..90d8d1cfd8 100644 --- a/docs/dyn/androidpublisher_v3.orders.html +++ b/docs/dyn/androidpublisher_v3.orders.html @@ -126,6 +126,8 @@

Method Details

}, "oneTimePurchaseDetails": { # Details of a one-time purchase. # Details of a one-time purchase. "offerId": "A String", # The offer ID of the one-time purchase offer. + "preorderDetails": { # Details of a pre-order purchase. # The details of a pre-order purchase. Only set if it is a pre-order purchase. Note that this field will be set even after pre-order is fulfilled. + }, "purchaseOptionId": "A String", # ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer. "quantity": 42, # The number of items purchased (for multi-quantity item purchases). "rentalDetails": { # Details of a rental purchase. # The details of a rent purchase. Only set if it is a rent purchase. @@ -270,6 +272,8 @@

Method Details

}, "oneTimePurchaseDetails": { # Details of a one-time purchase. # Details of a one-time purchase. "offerId": "A String", # The offer ID of the one-time purchase offer. + "preorderDetails": { # Details of a pre-order purchase. # The details of a pre-order purchase. Only set if it is a pre-order purchase. Note that this field will be set even after pre-order is fulfilled. + }, "purchaseOptionId": "A String", # ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer. "quantity": 42, # The number of items purchased (for multi-quantity item purchases). "rentalDetails": { # Details of a rental purchase. # The details of a rent purchase. Only set if it is a rent purchase. diff --git a/docs/dyn/androidpublisher_v3.purchases.productsv2.html b/docs/dyn/androidpublisher_v3.purchases.productsv2.html index 78b8b90b07..cdb4a38d4b 100644 --- a/docs/dyn/androidpublisher_v3.purchases.productsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.productsv2.html @@ -117,6 +117,9 @@

Method Details

"A String", ], "offerToken": "A String", # The per-transaction offer token used to make this purchase line item. + "preorderOfferDetails": { # Offer details information related to a preorder line item. # Offer details for a preorder offer. This will only be set for preorders. + "preorderReleaseTime": "A String", # The time when a preordered item is released for a preorder purchase. + }, "purchaseOptionId": "A String", # The purchase option ID. "quantity": 42, # The quantity associated with the purchase of the inapp product. "refundableQuantity": 42, # The quantity eligible for refund, i.e. quantity that hasn't been refunded. The value reflects quantity-based partial refunds and full refunds. diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index a223354063..287f11478e 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -5555,7 +5555,7 @@ } } }, -"revision": "20250904", +"revision": "20251028", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -9456,13 +9456,15 @@ false "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "NO_LONGER_AVAILABLE", -"AVAILABLE_IF_RELEASED" +"AVAILABLE_IF_RELEASED", +"AVAILABLE_FOR_OFFERS_ONLY" ], "enumDescriptions": [ "Unspecified availability. Must not be used.", "The purchase option is available to users.", "The purchase option is no longer available to users. This value can only be used if the availability was previously set as AVAILABLE.", -"The purchase option is initially unavailable, but made available via a released pre-order offer." +"The purchase option is initially unavailable, but made available via a released pre-order offer.", +"The purchase option is unavailable but offers linked to it (i.e. Play Points offer) are available." ], "type": "string" }, @@ -9518,6 +9520,10 @@ false "description": "The offer ID of the one-time purchase offer.", "type": "string" }, +"preorderDetails": { +"$ref": "PreorderDetails", +"description": "The details of a pre-order purchase. Only set if it is a pre-order purchase. Note that this field will be set even after pre-order is fulfilled." +}, "purchaseOptionId": { "description": "ID of the purchase option. This field is set for both purchase options and variant offers. For purchase options, this ID identifies the purchase option itself. For variant offers, this ID refers to the associated purchase option, and in conjunction with offer_id it identifies the variant offer.", "type": "string" @@ -9855,6 +9861,24 @@ false }, "type": "object" }, +"PreorderDetails": { +"description": "Details of a pre-order purchase.", +"id": "PreorderDetails", +"properties": {}, +"type": "object" +}, +"PreorderOfferDetails": { +"description": "Offer details information related to a preorder line item.", +"id": "PreorderOfferDetails", +"properties": { +"preorderReleaseTime": { +"description": "The time when a preordered item is released for a preorder purchase.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "PrepaidBasePlanType": { "description": "Represents a base plan that does not automatically renew at the end of the base plan, and must be manually renewed by the user.", "id": "PrepaidBasePlanType", @@ -10001,6 +10025,10 @@ false "description": "The per-transaction offer token used to make this purchase line item.", "type": "string" }, +"preorderOfferDetails": { +"$ref": "PreorderOfferDetails", +"description": "Offer details for a preorder offer. This will only be set for preorders." +}, "purchaseOptionId": { "description": "The purchase option ID.", "type": "string" From a0411b6f5cc087f24e7ffb2c3e55b75e68f7d3c7 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:09 +0000 Subject: [PATCH 07/70] feat(apigee): update the api #### apigee:v1 The following keys were added: - resources.organizations.resources.apis.resources.keyvaluemaps.methods.get (Total Keys: 11) - resources.organizations.resources.apis.resources.keyvaluemaps.methods.update (Total Keys: 12) - resources.organizations.resources.environments.resources.keyvaluemaps.methods.get (Total Keys: 11) - resources.organizations.resources.environments.resources.keyvaluemaps.methods.update (Total Keys: 12) - resources.organizations.resources.keyvaluemaps.methods.get (Total Keys: 11) - resources.organizations.resources.keyvaluemaps.methods.update (Total Keys: 12) --- ...ee_v1.organizations.apis.keyvaluemaps.html | 54 ++++++ ...ganizations.environments.keyvaluemaps.html | 54 ++++++ .../apigee_v1.organizations.keyvaluemaps.html | 54 ++++++ .../discovery_cache/documents/apigee.v1.json | 167 +++++++++++++++++- 4 files changed, 324 insertions(+), 5 deletions(-) diff --git a/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html b/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html index 0bc650acea..2b29bff3d4 100644 --- a/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html +++ b/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html @@ -88,6 +88,12 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes a key value map from an API proxy.

+

+ get(name, x__xgafv=None)

+

Get the key value map scoped to an organization, environment, or API proxy.

+

+ update(name, body=None, x__xgafv=None)

+

Update the key value map scoped to an organization, environment, or API proxy.

Method Details

close() @@ -142,4 +148,52 @@

Method Details

}
+
+ get(name, x__xgafv=None) + 
Get the key value map scoped to an organization, environment, or API proxy.
+
+Args:
+  name: string, Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+ +
+ update(name, body=None, x__xgafv=None) + 
Update the key value map scoped to an organization, environment, or API proxy.
+
+Args:
+  name: string, Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html b/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html index 14f9006c9b..7ccef9de23 100644 --- a/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html +++ b/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html @@ -88,6 +88,12 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes a key value map from an environment.

+

+ get(name, x__xgafv=None)

+

Get the key value map scoped to an organization, environment, or API proxy.

+

+ update(name, body=None, x__xgafv=None)

+

Update the key value map scoped to an organization, environment, or API proxy.

Method Details

close() @@ -142,4 +148,52 @@

Method Details

}
+
+ get(name, x__xgafv=None) + 
Get the key value map scoped to an organization, environment, or API proxy.
+
+Args:
+  name: string, Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+ +
+ update(name, body=None, x__xgafv=None) + 
Update the key value map scoped to an organization, environment, or API proxy.
+
+Args:
+  name: string, Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/apigee_v1.organizations.keyvaluemaps.html b/docs/dyn/apigee_v1.organizations.keyvaluemaps.html index 76a827a814..bb4e57aacb 100644 --- a/docs/dyn/apigee_v1.organizations.keyvaluemaps.html +++ b/docs/dyn/apigee_v1.organizations.keyvaluemaps.html @@ -88,6 +88,12 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes a key value map from an organization.

+

+ get(name, x__xgafv=None)

+

Get the key value map scoped to an organization, environment, or API proxy.

+

+ update(name, body=None, x__xgafv=None)

+

Update the key value map scoped to an organization, environment, or API proxy.

Method Details

close() @@ -142,4 +148,52 @@

Method Details

}
+
+ get(name, x__xgafv=None) + 
Get the key value map scoped to an organization, environment, or API proxy.
+
+Args:
+  name: string, Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+ +
+ update(name, body=None, x__xgafv=None) + 
Update the key value map scoped to an organization, environment, or API proxy.
+
+Args:
+  name: string, Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of key/value string pairs.
+  "encrypted": True or False, # Required. Flag that specifies whether entry values will be encrypted. This field is retained for backward compatibility and the value of encrypted will always be `true`. Apigee X and hybrid do not support unencrypted key value maps.
+  "name": "A String", # Required. ID of the key value map.
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 5178b24f7a..3dceae1c05 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -1592,6 +1592,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"description": "Get the key value map scoped to an organization, environment, or API proxy.", +"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}", +"httpMethod": "GET", +"id": "apigee.organizations.apis.keyvaluemaps.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", +"location": "path", +"pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"update": { +"description": "Update the key value map scoped to an organization, environment, or API proxy.", +"flatPath": "v1/organizations/{organizationsId}/apis/{apisId}/keyvaluemaps/{keyvaluemapsId}", +"httpMethod": "PUT", +"id": "apigee.organizations.apis.keyvaluemaps.update", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", +"location": "path", +"pattern": "^organizations/[^/]+/apis/[^/]+/keyvaluemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"response": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -6276,6 +6329,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"description": "Get the key value map scoped to an organization, environment, or API proxy.", +"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}", +"httpMethod": "GET", +"id": "apigee.organizations.environments.keyvaluemaps.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", +"location": "path", +"pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"update": { +"description": "Update the key value map scoped to an organization, environment, or API proxy.", +"flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/keyvaluemaps/{keyvaluemapsId}", +"httpMethod": "PUT", +"id": "apigee.organizations.environments.keyvaluemaps.update", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", +"location": "path", +"pattern": "^organizations/[^/]+/environments/[^/]+/keyvaluemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"response": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -9100,6 +9206,59 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"description": "Get the key value map scoped to an organization, environment, or API proxy.", +"flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}", +"httpMethod": "GET", +"id": "apigee.organizations.keyvaluemaps.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", +"location": "path", +"pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"update": { +"description": "Update the key value map scoped to an organization, environment, or API proxy.", +"flatPath": "v1/organizations/{organizationsId}/keyvaluemaps/{keyvaluemapsId}", +"httpMethod": "PUT", +"id": "apigee.organizations.keyvaluemaps.update", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Scope as indicated by the URI in which to fetch the key value map. Use **one** of the following structures in your request: * `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. * `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}` * `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. If the KeyValueMap is under an API Proxy resource that has the `space` attribute set, IAM permissions are checked against the Space resource path. To learn more, read the [Apigee Spaces Overview](https://cloud.google.com/apigee/docs/api-platform/system-administration/spaces/apigee-spaces-overview).", +"location": "path", +"pattern": "^organizations/[^/]+/keyvaluemaps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"response": { +"$ref": "GoogleCloudApigeeV1KeyValueMap" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -11289,7 +11448,7 @@ } } }, -"revision": "20250929", +"revision": "20251016", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -18771,14 +18930,12 @@ "enum": [ "ATTRIBUTE_UNSPECIFIED", "ATTRIBUTE_ENVIRONMENTS", -"ATTRIBUTE_IP_ADDRESS_RANGES", -"ATTRIBUTE_API_KEYS" +"ATTRIBUTE_IP_ADDRESS_RANGES" ], "enumDescriptions": [ "Unspecified attribute.", "Values will be a list of environments.", -"Values will be a list of IP addresses. This could be either IPv4 or IPv6.", -"Values will be a list of API keys." +"Values will be a list of IP addresses. This could be either IPv4 or IPv6." ], "type": "string" }, From f820a3b6cd6fdcb90a02f0635cc53b231fd340f3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:09 +0000 Subject: [PATCH 08/70] feat(apihub): update the api #### apihub:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GoogleLongrunningListOperationsResponse.properties.unreachable (Total Keys: 2) --- .../apihub_v1.projects.locations.apis.html | 16 +++++++------- ...ts.locations.apis.versions.operations.html | 4 ++-- docs/dyn/apihub_v1.projects.locations.html | 6 ++--- ...ihub_v1.projects.locations.operations.html | 8 +++++-- .../discovery_cache/documents/apihub.v1.json | 22 ++++++++++++++----- 5 files changed, 36 insertions(+), 20 deletions(-) diff --git a/docs/dyn/apihub_v1.projects.locations.apis.html b/docs/dyn/apihub_v1.projects.locations.apis.html index 317e7a3284..aba6cc3358 100644 --- a/docs/dyn/apihub_v1.projects.locations.apis.html +++ b/docs/dyn/apihub_v1.projects.locations.apis.html @@ -99,7 +99,7 @@

Instance Methods

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.

+

Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes * fingerprint The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.

Method Details

close() @@ -292,7 +292,7 @@

Method Details

"documentation": { # Documentation details. # Optional. The documentation for the API resource. "externalUri": "A String", # Optional. The uri of the externally hosted documentation. }, - "fingerprint": "A String", # Optional. Fingerprint of the API resource. + "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -587,7 +587,7 @@

Method Details

"documentation": { # Documentation details. # Optional. The documentation for the API resource. "externalUri": "A String", # Optional. The uri of the externally hosted documentation. }, - "fingerprint": "A String", # Optional. Fingerprint of the API resource. + "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -907,7 +907,7 @@

Method Details

"documentation": { # Documentation details. # Optional. The documentation for the API resource. "externalUri": "A String", # Optional. The uri of the externally hosted documentation. }, - "fingerprint": "A String", # Optional. Fingerprint of the API resource. + "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1213,7 +1213,7 @@

Method Details

"documentation": { # Documentation details. # Optional. The documentation for the API resource. "externalUri": "A String", # Optional. The uri of the externally hosted documentation. }, - "fingerprint": "A String", # Optional. Fingerprint of the API resource. + "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource. "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum. @@ -1342,7 +1342,7 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) - 
Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.
+  
Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes * fingerprint The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.
 
 Args:
   name: string, Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}` (required)
@@ -1526,7 +1526,7 @@ 
Method Details

   "documentation": { # Documentation details. # Optional. The documentation for the API resource.
     "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
   },
-  "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+  "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.
   "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
     "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
     "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
@@ -1821,7 +1821,7 @@ 
Method Details

   "documentation": { # Documentation details. # Optional. The documentation for the API resource.
     "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
   },
-  "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+  "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.
   "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
     "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
     "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
diff --git a/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html b/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html
index 57c2e4d090..9c29a4a8fd 100644
--- a/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html
+++ b/docs/dyn/apihub_v1.projects.locations.apis.versions.operations.html
@@ -94,7 +94,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   patch(name, body=None, updateMask=None, x__xgafv=None)

-
Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.

+
Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool.description * details.input_schema * details.output_schema * details.mcp_tool.annotations.title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool.annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations.additional_hints The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.

 
Method Details

 

     close()
@@ -444,7 +444,7 @@ 
Method Details

 
 

     patch(name, body=None, updateMask=None, x__xgafv=None)
-  
Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.
+  
Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool.description * details.input_schema * details.output_schema * details.mcp_tool.annotations.title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool.annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations.additional_hints The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.
 
 Args:
   name: string, Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}` (required)
diff --git a/docs/dyn/apihub_v1.projects.locations.html b/docs/dyn/apihub_v1.projects.locations.html
index bee6b7afaa..ef31ca6a60 100644
--- a/docs/dyn/apihub_v1.projects.locations.html
+++ b/docs/dyn/apihub_v1.projects.locations.html
@@ -356,7 +356,7 @@ 
Method Details

             "documentation": { # Documentation details. # Optional. The documentation for the API resource.
               "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
             },
-            "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+            "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.
             "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
               "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
               "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
@@ -1036,7 +1036,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
@@ -1309,7 +1309,7 @@ 
Method Details

           "documentation": { # Documentation details. # Optional. The documentation for the API resource.
             "externalUri": "A String", # Optional. The uri of the externally hosted documentation.
           },
-          "fingerprint": "A String", # Optional. Fingerprint of the API resource.
+          "fingerprint": "A String", # Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.
           "maturityLevel": { # The attribute values associated with resource. # Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
             "attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
             "enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
diff --git a/docs/dyn/apihub_v1.projects.locations.operations.html b/docs/dyn/apihub_v1.projects.locations.operations.html
index 7dc75fe371..167edbc22b 100644
--- a/docs/dyn/apihub_v1.projects.locations.operations.html
+++ b/docs/dyn/apihub_v1.projects.locations.operations.html
@@ -87,7 +87,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -176,7 +176,7 @@ 
Method Details

 

 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
   
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }

 

 
diff --git a/googleapiclient/discovery_cache/documents/apihub.v1.json b/googleapiclient/discovery_cache/documents/apihub.v1.json
index aa4446323d..7ee1644535 100644
--- a/googleapiclient/discovery_cache/documents/apihub.v1.json
+++ b/googleapiclient/discovery_cache/documents/apihub.v1.json
@@ -172,7 +172,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -508,7 +508,7 @@
 ]
 },
 "patch": {
-"description": "Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.",
+"description": "Update an API resource in the API hub. The following fields in the API can be updated: * display_name * description * owner * documentation * target_user * team * business_unit * maturity_level * api_style * attributes * fingerprint The update_mask should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}",
 "httpMethod": "PATCH",
 "id": "apihub.projects.locations.apis.patch",
@@ -866,7 +866,7 @@
 ]
 },
 "patch": {
-"description": "Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.",
+"description": "Update an operation in an API version. The following fields in the ApiOperation resource can be updated: * details.description * details.documentation * details.http_operation.path * details.http_operation.method * details.deprecated * attributes * details.mcp_tool.title * details.mcp_tool.description * details.input_schema * details.output_schema * details.mcp_tool.annotations.title * details.mcp_tool.annotations.read_only_hint * details.mcp_tool.annotations.destructive_hint * details.mcp_tool.annotations.idempotent_hint * details.mcp_tool.annotations.open_world_hint * details.mcp_tool.annotations.additional_hints The update_mask should be used to specify the fields being updated. An operation can be updated only if the operation was created via CreateApiOperation API. If the operation was created by parsing the spec, then it can be edited by updating the spec.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apis/{apisId}/versions/{versionsId}/operations/{operationsId}",
 "httpMethod": "PATCH",
 "id": "apihub.projects.locations.apis.versions.operations.patch",
@@ -2276,6 +2276,11 @@
 "description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1/{+name}/operations",
@@ -2974,7 +2979,7 @@
 }
 }
 },
-"revision": "20250912",
+"revision": "20251025",
 "rootUrl": "https://apihub.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -3099,7 +3104,7 @@
 "description": "Optional. The documentation for the API resource."
 },
 "fingerprint": {
-"description": "Optional. Fingerprint of the API resource.",
+"description": "Optional. Fingerprint of the API resource. This must be unique for each API resource. It can neither be unset nor be updated to an existing fingerprint of another API resource.",
 "type": "string"
 },
 "maturityLevel": {
@@ -6515,6 +6520,13 @@
 "$ref": "GoogleLongrunningOperation"
 },
 "type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"

From 0cde10dd690e2ca303b8dddd26baee762b12e103 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:09 +0000
Subject: [PATCH 09/70] feat(apphub): update the api

#### apphub:v1

The following keys were added:
- schemas.FunctionalType (Total Keys: 4)
- schemas.ServiceProperties.properties.functionalType (Total Keys: 2)
- schemas.WorkloadProperties.properties.functionalType (Total Keys: 2)

#### apphub:v1alpha

The following keys were added:
- schemas.FunctionalType (Total Keys: 4)
- schemas.ServiceProperties.properties.functionalType (Total Keys: 2)
- schemas.WorkloadProperties.properties.functionalType (Total Keys: 2)
---
 ...jects.locations.applications.services.html | 12 +++++++
 ...ects.locations.applications.workloads.html | 12 +++++++
 ...projects.locations.discoveredServices.html |  9 +++++
 ...rojects.locations.discoveredWorkloads.html |  9 +++++
 docs/dyn/apphub_v1.projects.locations.html    |  2 +-
 ...jects.locations.applications.services.html | 12 +++++++
 ...ects.locations.applications.workloads.html | 12 +++++++
 ...projects.locations.discoveredServices.html | 12 +++++++
 ...rojects.locations.discoveredWorkloads.html | 12 +++++++
 .../apphub_v1alpha.projects.locations.html    |  2 +-
 .../discovery_cache/documents/apphub.v1.json  | 36 +++++++++++++++++--
 .../documents/apphub.v1alpha.json             | 36 +++++++++++++++++--
 12 files changed, 160 insertions(+), 6 deletions(-)

diff --git a/docs/dyn/apphub_v1.projects.locations.applications.services.html b/docs/dyn/apphub_v1.projects.locations.applications.services.html
index 65c6ab727d..da78205aa4 100644
--- a/docs/dyn/apphub_v1.projects.locations.applications.services.html
+++ b/docs/dyn/apphub_v1.projects.locations.applications.services.html
@@ -143,6 +143,9 @@ 
Method Details

   "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
   "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -269,6 +272,9 @@ 
Method Details

   "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
   "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -336,6 +342,9 @@ 
Method Details

       "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
       "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
       "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
         "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
         "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -410,6 +419,9 @@ 
Method Details

   "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
   "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1.projects.locations.applications.workloads.html b/docs/dyn/apphub_v1.projects.locations.applications.workloads.html
index 9a6c776471..9e7463b4f5 100644
--- a/docs/dyn/apphub_v1.projects.locations.applications.workloads.html
+++ b/docs/dyn/apphub_v1.projects.locations.applications.workloads.html
@@ -146,6 +146,9 @@ 
Method Details

   "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
   "updateTime": "A String", # Output only. Update time.
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -272,6 +275,9 @@ 
Method Details

   "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
   "updateTime": "A String", # Output only. Update time.
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -342,6 +348,9 @@ 
Method Details

       "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
       "updateTime": "A String", # Output only. Update time.
       "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
         "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
         "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -413,6 +422,9 @@ 
Method Details

   "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
   "updateTime": "A String", # Output only. Update time.
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1.projects.locations.discoveredServices.html b/docs/dyn/apphub_v1.projects.locations.discoveredServices.html
index 4d77049412..5da114caf7 100644
--- a/docs/dyn/apphub_v1.projects.locations.discoveredServices.html
+++ b/docs/dyn/apphub_v1.projects.locations.discoveredServices.html
@@ -112,6 +112,9 @@ 
Method Details

     { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
   "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -145,6 +148,9 @@ 
Method Details

     { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
       "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
       "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
         "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
         "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -194,6 +200,9 @@ 
Method Details

   "discoveredService": { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service. # Discovered Service if exists, empty otherwise.
     "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
     "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+      "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+        "type": "A String", # Output only. The functional type of a service or workload.
+      },
       "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
       "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
       "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1.projects.locations.discoveredWorkloads.html b/docs/dyn/apphub_v1.projects.locations.discoveredWorkloads.html
index 991ef2002a..6e766236a9 100644
--- a/docs/dyn/apphub_v1.projects.locations.discoveredWorkloads.html
+++ b/docs/dyn/apphub_v1.projects.locations.discoveredWorkloads.html
@@ -112,6 +112,9 @@ 
Method Details

     { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
   "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -145,6 +148,9 @@ 
Method Details

     { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
       "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
       "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
         "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
         "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -194,6 +200,9 @@ 
Method Details

   "discoveredWorkload": { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload. # Discovered Workload if exists, empty otherwise.
     "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
     "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+      "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+        "type": "A String", # Output only. The functional type of a service or workload.
+      },
       "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
       "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
       "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1.projects.locations.html b/docs/dyn/apphub_v1.projects.locations.html
index 08eec3a1be..d2090ed4d8 100644
--- a/docs/dyn/apphub_v1.projects.locations.html
+++ b/docs/dyn/apphub_v1.projects.locations.html
@@ -180,7 +180,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html b/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html
index 85d5d80a12..4bf380ac08 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.applications.services.html
@@ -155,6 +155,9 @@ 
Method Details

   "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
   "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -294,6 +297,9 @@ 
Method Details

   "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
   "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -374,6 +380,9 @@ 
Method Details

       "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
       "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
       "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
         "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
         "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -461,6 +470,9 @@ 
Method Details

   "displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
   "name": "A String", # Identifier. The resource name of a Service. Format: `"projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html b/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html
index fc4ca083e3..6536aac4fa 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.applications.workloads.html
@@ -158,6 +158,9 @@ 
Method Details

   "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
   "updateTime": "A String", # Output only. Update time.
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -296,6 +299,9 @@ 
Method Details

   "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
   "updateTime": "A String", # Output only. Update time.
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -378,6 +384,9 @@ 
Method Details

       "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
       "updateTime": "A String", # Output only. Update time.
       "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
         "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
         "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -461,6 +470,9 @@ 
Method Details

   "uid": "A String", # Output only. A universally unique identifier (UUID) for the `Workload` in the UUID4 format.
   "updateTime": "A String", # Output only. Update time.
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.discoveredServices.html b/docs/dyn/apphub_v1alpha.projects.locations.discoveredServices.html
index 1d2a1eafd6..3b22616e70 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.discoveredServices.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.discoveredServices.html
@@ -124,6 +124,9 @@ 
Method Details

     { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
       "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
       "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
         "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
         "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -172,6 +175,9 @@ 
Method Details

     { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
   "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
   "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
     "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
     "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -206,6 +212,9 @@ 
Method Details

     { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
       "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
       "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
         "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
         "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
@@ -256,6 +265,9 @@ 
Method Details

   "discoveredService": { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service. # Discovered Service if exists, empty otherwise.
     "name": "A String", # Identifier. The resource name of the discovered service. Format: `"projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}"`
     "serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
+      "functionalType": { # The functional type of a service or workload. # Output only. The type of the service.
+        "type": "A String", # Output only. The functional type of a service or workload.
+      },
       "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
       "location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
       "zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.discoveredWorkloads.html b/docs/dyn/apphub_v1alpha.projects.locations.discoveredWorkloads.html
index 1de7f6862e..79064077ab 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.discoveredWorkloads.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.discoveredWorkloads.html
@@ -124,6 +124,9 @@ 
Method Details

     { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
       "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
       "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
         "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
         "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -171,6 +174,9 @@ 
Method Details

     { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
   "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
   "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+    "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+      "type": "A String", # Output only. The functional type of a service or workload.
+    },
     "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
     "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
     "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -204,6 +210,9 @@ 
Method Details

     { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
       "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
       "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+        "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+          "type": "A String", # Output only. The functional type of a service or workload.
+        },
         "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
         "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
         "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
@@ -253,6 +262,9 @@ 
Method Details

   "discoveredWorkload": { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload. # Discovered Workload if exists, empty otherwise.
     "name": "A String", # Identifier. The resource name of the discovered workload. Format: `"projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}"`
     "workloadProperties": { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
+      "functionalType": { # The functional type of a service or workload. # Output only. The type of the workload.
+        "type": "A String", # Output only. The functional type of a service or workload.
+      },
       "gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
       "location": "A String", # Output only. The location that the underlying compute resource resides in (for example, us-west1).
       "zone": "A String", # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
diff --git a/docs/dyn/apphub_v1alpha.projects.locations.html b/docs/dyn/apphub_v1alpha.projects.locations.html
index c8e4b18d55..77ecd17412 100644
--- a/docs/dyn/apphub_v1alpha.projects.locations.html
+++ b/docs/dyn/apphub_v1alpha.projects.locations.html
@@ -180,7 +180,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/apphub.v1.json b/googleapiclient/discovery_cache/documents/apphub.v1.json
index 539d35dda5..efd3c68d16 100644
--- a/googleapiclient/discovery_cache/documents/apphub.v1.json
+++ b/googleapiclient/discovery_cache/documents/apphub.v1.json
@@ -172,7 +172,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1357,7 +1357,7 @@
 }
 }
 },
-"revision": "20251001",
+"revision": "20251028",
 "rootUrl": "https://apphub.googleapis.com/",
 "schemas": {
 "Application": {
@@ -1681,6 +1681,28 @@
 },
 "type": "object"
 },
+"FunctionalType": {
+"description": "The functional type of a service or workload.",
+"id": "FunctionalType",
+"properties": {
+"type": {
+"description": "Output only. The functional type of a service or workload.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"AGENT",
+"MCP_SERVER"
+],
+"enumDescriptions": [
+"Unspecified type.",
+"Agent type.",
+"MCP Server type."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "ListApplicationsResponse": {
 "description": "Response for ListApplications.",
 "id": "ListApplicationsResponse",
@@ -2223,6 +2245,11 @@ false
 "description": "Properties of an underlying cloud resource that can comprise a Service.",
 "id": "ServiceProperties",
 "properties": {
+"functionalType": {
+"$ref": "FunctionalType",
+"description": "Output only. The type of the service.",
+"readOnly": true
+},
 "gcpProject": {
 "description": "Output only. The service project identifier that the underlying cloud resource resides in.",
 "readOnly": true,
@@ -2401,6 +2428,11 @@ false
 "description": "Properties of an underlying compute resource represented by the Workload.",
 "id": "WorkloadProperties",
 "properties": {
+"functionalType": {
+"$ref": "FunctionalType",
+"description": "Output only. The type of the workload.",
+"readOnly": true
+},
 "gcpProject": {
 "description": "Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.",
 "readOnly": true,
diff --git a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json
index a997cc1bb6..5ba73714a6 100644
--- a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json
@@ -172,7 +172,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1449,7 +1449,7 @@
 }
 }
 },
-"revision": "20251001",
+"revision": "20251028",
 "rootUrl": "https://apphub.googleapis.com/",
 "schemas": {
 "Application": {
@@ -1853,6 +1853,28 @@
 },
 "type": "object"
 },
+"FunctionalType": {
+"description": "The functional type of a service or workload.",
+"id": "FunctionalType",
+"properties": {
+"type": {
+"description": "Output only. The functional type of a service or workload.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"AGENT",
+"MCP_SERVER"
+],
+"enumDescriptions": [
+"Unspecified type.",
+"Agent type.",
+"MCP Server type."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "ListApplicationsResponse": {
 "description": "Response for ListApplications.",
 "id": "ListApplicationsResponse",
@@ -2364,6 +2386,11 @@
 "description": "Properties of an underlying cloud resource that can comprise a Service.",
 "id": "ServiceProperties",
 "properties": {
+"functionalType": {
+"$ref": "FunctionalType",
+"description": "Output only. The type of the service.",
+"readOnly": true
+},
 "gcpProject": {
 "description": "Output only. The service project identifier that the underlying cloud resource resides in.",
 "readOnly": true,
@@ -2547,6 +2574,11 @@
 "description": "Properties of an underlying compute resource represented by the Workload.",
 "id": "WorkloadProperties",
 "properties": {
+"functionalType": {
+"$ref": "FunctionalType",
+"description": "Output only. The type of the workload.",
+"readOnly": true
+},
 "gcpProject": {
 "description": "Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.",
 "readOnly": true,

From c5e5cbd48fac599f541b4bb0671f73504bd95331 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:09 +0000
Subject: [PATCH 10/70] feat(artifactregistry): update the api

#### artifactregistry:v1

The following keys were added:
- resources.projects.resources.locations.resources.repositories.methods.exportArtifact (Total Keys: 12)
- schemas.ExportArtifactMetadata (Total Keys: 4)
- schemas.ExportArtifactRequest (Total Keys: 4)
- schemas.ExportArtifactResponse (Total Keys: 3)
- schemas.ExportedFile (Total Keys: 6)
---
 ...ry_v1.projects.locations.repositories.html |  47 ++++++++
 .../documents/artifactregistry.v1.json        | 104 +++++++++++++++++-
 2 files changed, 147 insertions(+), 4 deletions(-)

diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
index 243790b32e..9d5cb97833 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.html
@@ -153,6 +153,9 @@ 
Instance Methods

 

   delete(name, x__xgafv=None)

 
Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

+

+  exportArtifact(repository, body=None, x__xgafv=None)

+
Exports an artifact.

 

   get(name, x__xgafv=None)

 
Gets a repository.

@@ -376,6 +379,50 @@ 
Method Details

 }
+
+ exportArtifact(repository, body=None, x__xgafv=None) + 
Exports an artifact.
+
+Args:
+  repository: string, Required. The repository of the artifact to export. Format: projects/{project}/locations/{location}/repositories/{repository} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for exporting an artifact to a destination.
+  "gcsPath": "A String", # The Cloud Storage path to export the artifact to. Should start with the bucket name, and optionally have a directory path. Examples: `dst_bucket`, `dst_bucket/sub_dir`. Existing objects with the same path will be overwritten.
+  "sourceTag": "A String", # The artifact tag to export. Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}
+  "sourceVersion": "A String", # The artifact version to export. Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
get(name, x__xgafv=None) 
Gets a repository.
diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json
index 5309ddb660..f453a1e96e 100644
--- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json
+++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json
@@ -637,6 +637,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"exportArtifact": {
+"description": "Exports an artifact.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:exportArtifact",
+"httpMethod": "POST",
+"id": "artifactregistry.projects.locations.repositories.exportArtifact",
+"parameterOrder": [
+"repository"
+],
+"parameters": {
+"repository": {
+"description": "Required. The repository of the artifact to export. Format: projects/{project}/locations/{location}/repositories/{repository}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+repository}:exportArtifact",
+"request": {
+"$ref": "ExportArtifactRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
 "description": "Gets a repository.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}",
@@ -2465,7 +2493,7 @@
 }
 }
 },
-"revision": "20250925",
+"revision": "20251017",
 "rootUrl": "https://artifactregistry.googleapis.com/",
 "schemas": {
 "AptArtifact": {
@@ -2849,6 +2877,72 @@
 "properties": {},
 "type": "object"
 },
+"ExportArtifactMetadata": {
+"description": "The LRO metadata for exporting an artifact.",
+"id": "ExportArtifactMetadata",
+"properties": {
+"exportedFiles": {
+"description": "The exported artifact files.",
+"items": {
+"$ref": "ExportedFile"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"ExportArtifactRequest": {
+"description": "The request for exporting an artifact to a destination.",
+"id": "ExportArtifactRequest",
+"properties": {
+"gcsPath": {
+"description": "The Cloud Storage path to export the artifact to. Should start with the bucket name, and optionally have a directory path. Examples: `dst_bucket`, `dst_bucket/sub_dir`. Existing objects with the same path will be overwritten.",
+"type": "string"
+},
+"sourceTag": {
+"description": "The artifact tag to export. Format:projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/tags/{tag}",
+"type": "string"
+},
+"sourceVersion": {
+"description": "The artifact version to export. Format: projects/{project}/locations/{location}/repositories/{repository}/packages/{package}/versions/{version}",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ExportArtifactResponse": {
+"description": "The response for exporting an artifact to a destination.",
+"id": "ExportArtifactResponse",
+"properties": {
+"exportedVersion": {
+"$ref": "Version",
+"description": "The exported version. Should be the same as the request version with fingerprint resource name."
+}
+},
+"type": "object"
+},
+"ExportedFile": {
+"description": "The exported artifact file.",
+"id": "ExportedFile",
+"properties": {
+"gcsObjectPath": {
+"description": "Cloud Storage Object path of the exported file. Examples: `dst_bucket/file1`, `dst_bucket/sub_dir/file1`",
+"type": "string"
+},
+"hashes": {
+"description": "The hashes of the file content.",
+"items": {
+"$ref": "Hash"
+},
+"type": "array"
+},
+"name": {
+"description": "Name of the exported artifact file. Format: `projects/p1/locations/us/repositories/repo1/files/file1`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Expr": {
 "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
 "id": "Expr",
@@ -4115,7 +4209,8 @@ false
 "PYTHON",
 "KFP",
 "GO",
-"GENERIC"
+"GENERIC",
+"RUBY"
 ],
 "enumDescriptions": [
 "Unspecified package format.",
@@ -4128,7 +4223,8 @@ false
 "Python package format.",
 "Kubeflow Pipelines package format.",
 "Go package format.",
-"Generic package format."
+"Generic package format.",
+"Ruby package format."
 ],
 "type": "string"
 },
@@ -4666,7 +4762,7 @@ false
 "DISABLED"
 ],
 "enumDescriptions": [
-"Not set. This will be treated as INHERITED.",
+"Not set. This will be treated as INHERITED for Docker repositories and DISABLED for non-Docker repositories.",
 "Scanning is Enabled, but dependent on API enablement.",
 "No automatic vulnerability scanning will be performed for this repository."
 ],

From 4b1a58e965c744981d87598ff4d1d9caeb5ad442 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:09 +0000
Subject: [PATCH 11/70] feat(authorizedbuyersmarketplace): update the api

#### authorizedbuyersmarketplace:v1

The following keys were added:
- resources.bidders.resources.finalizedDeals.methods.setReadyToServe (Total Keys: 12)

#### authorizedbuyersmarketplace:v1alpha

The following keys were added:
- resources.bidders.resources.finalizedDeals.methods.setReadyToServe (Total Keys: 12)
---
 ...marketplace_v1.bidders.finalizedDeals.html | 265 ++++++++++++++++++
 ...smarketplace_v1.buyers.finalizedDeals.html |   6 +-
 ...tplace_v1alpha.bidders.finalizedDeals.html | 265 ++++++++++++++++++
 ...etplace_v1alpha.buyers.finalizedDeals.html |   6 +-
 .../authorizedbuyersmarketplace.v1.json       |  34 ++-
 .../authorizedbuyersmarketplace.v1alpha.json  |  34 ++-
 6 files changed, 598 insertions(+), 12 deletions(-)

diff --git a/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html
index 5f5bb53159..181e49a046 100644
--- a/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html
+++ b/docs/dyn/authorizedbuyersmarketplace_v1.bidders.finalizedDeals.html
@@ -83,6 +83,9 @@ 
Instance Methods

 

   list_next()

 
Retrieves the next page of results.

+

+  setReadyToServe(deal, body=None, x__xgafv=None)

+
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

 
Method Details

 

     close()
@@ -368,4 +371,266 @@ 
Method Details
+
+ setReadyToServe(deal, body=None, x__xgafv=None) + 
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.
+
+Args:
+  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for setting ready to serve for a finalized deal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html index a2cc4d163d..43b16ecaf5 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html @@ -97,7 +97,7 @@

Instance Methods

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

setReadyToServe(deal, body=None, x__xgafv=None)

-

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

+

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

Method Details

addCreative(deal, body=None, x__xgafv=None) @@ -1429,10 +1429,10 @@

Method Details

setReadyToServe(deal, body=None, x__xgafv=None) - 
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.
+  
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.
 
 Args:
-  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}` (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html
index 63aa0829e4..20ada7b140 100644
--- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html
@@ -83,6 +83,9 @@ 
Instance Methods

 

   list_next()

 
Retrieves the next page of results.

+

+  setReadyToServe(deal, body=None, x__xgafv=None)

+
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

 
Method Details

 

     close()
@@ -368,4 +371,266 @@ 
Method Details
+
+ setReadyToServe(deal, body=None, x__xgafv=None) + 
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.
+
+Args:
+  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for setting ready to serve for a finalized deal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+          "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+          "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html index a12f896313..68f7c646ef 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html @@ -97,7 +97,7 @@

Instance Methods

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

setReadyToServe(deal, body=None, x__xgafv=None)

-

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

+

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

Method Details

addCreative(deal, body=None, x__xgafv=None) @@ -1429,10 +1429,10 @@

Method Details

setReadyToServe(deal, body=None, x__xgafv=None) - 
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.
+  
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.
 
 Args:
-  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}` (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json
index 41eb39dce4..e96345705e 100644
--- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json
+++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json
@@ -204,6 +204,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/authorized-buyers-marketplace"
 ]
+},
+"setReadyToServe": {
+"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.",
+"flatPath": "v1/bidders/{biddersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe",
+"httpMethod": "POST",
+"id": "authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe",
+"parameterOrder": [
+"deal"
+],
+"parameters": {
+"deal": {
+"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`",
+"location": "path",
+"pattern": "^bidders/[^/]+/finalizedDeals/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+deal}:setReadyToServe",
+"request": {
+"$ref": "SetReadyToServeRequest"
+},
+"response": {
+"$ref": "FinalizedDeal"
+},
+"scopes": [
+"https://www.googleapis.com/auth/authorized-buyers-marketplace"
+]
 }
 }
 }
@@ -920,7 +948,7 @@
 ]
 },
 "setReadyToServe": {
-"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.",
+"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.",
 "flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe",
 "httpMethod": "POST",
 "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe",
@@ -929,7 +957,7 @@
 ],
 "parameters": {
 "deal": {
-"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`",
+"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`",
 "location": "path",
 "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
 "required": true,
@@ -1367,7 +1395,7 @@
 }
 }
 },
-"revision": "20250828",
+"revision": "20251028",
 "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
 "schemas": {
 "AcceptProposalRequest": {
diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
index 1addb9a36d..c74e1f0c86 100644
--- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json
@@ -204,6 +204,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/authorized-buyers-marketplace"
 ]
+},
+"setReadyToServe": {
+"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.",
+"flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe",
+"httpMethod": "POST",
+"id": "authorizedbuyersmarketplace.bidders.finalizedDeals.setReadyToServe",
+"parameterOrder": [
+"deal"
+],
+"parameters": {
+"deal": {
+"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`",
+"location": "path",
+"pattern": "^bidders/[^/]+/finalizedDeals/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+deal}:setReadyToServe",
+"request": {
+"$ref": "SetReadyToServeRequest"
+},
+"response": {
+"$ref": "FinalizedDeal"
+},
+"scopes": [
+"https://www.googleapis.com/auth/authorized-buyers-marketplace"
+]
 }
 }
 }
@@ -1103,7 +1131,7 @@
 ]
 },
 "setReadyToServe": {
-"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.",
+"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals/{dealId}\" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.",
 "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe",
 "httpMethod": "POST",
 "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe",
@@ -1112,7 +1140,7 @@
 ],
 "parameters": {
 "deal": {
-"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`",
+"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` or `bidders/{accountId}/finalizedDeals/{dealId}`",
 "location": "path",
 "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
 "required": true,
@@ -1550,7 +1578,7 @@
 }
 }
 },
-"revision": "20250910",
+"revision": "20251028",
 "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
 "schemas": {
 "AcceptProposalRequest": {

From 9ea2eb7f2c1bea7de204c1641ad2b2fa232cfad8 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:10 +0000
Subject: [PATCH 12/70] feat(backupdr): update the api

#### backupdr:v1

The following keys were added:
- resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.fetchForResourceType (Total Keys: 24)
- resources.projects.resources.locations.resources.dataSourceReferences.methods.list (Total Keys: 20)
- schemas.Backup.properties.gcpResource (Total Keys: 2)
- schemas.BackupGcpResource (Total Keys: 5)
- schemas.BackupPlan.properties.maxCustomOnDemandRetentionDays (Total Keys: 2)
- schemas.CloudSqlInstanceBackupProperties.properties.instanceCreateTime (Total Keys: 3)
- schemas.CloudSqlInstanceBackupProperties.properties.instanceDeleteTime (Total Keys: 3)
- schemas.DataSourceReference.properties.totalStoredBytes (Total Keys: 3)
- schemas.FetchBackupsForResourceTypeResponse (Total Keys: 5)
- schemas.ListDataSourceReferencesResponse (Total Keys: 5)
- schemas.TriggerBackupRequest.properties.customRetentionDays (Total Keys: 2)
---
 ...ects.locations.backupPlanAssociations.html |   1 +
 ...pdr_v1.projects.locations.backupPlans.html |   4 +
 ...jects.locations.backupPlans.revisions.html |   2 +
 ...ions.backupVaults.dataSources.backups.html | 323 ++++++++++++++++++
 ...ojects.locations.dataSourceReferences.html |  70 ++++
 docs/dyn/backupdr_v1.projects.locations.html  |   2 +-
 .../documents/backupdr.v1.json                | 204 ++++++++++-
 7 files changed, 603 insertions(+), 3 deletions(-)

diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html
index 7f4417f0cb..05e3b51bd4 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html
@@ -490,6 +490,7 @@ 
Method Details

     The object takes the form of:
 
 { # Request message for triggering a backup.
+  "customRetentionDays": 42, # Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in "days". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.
   "requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   "ruleId": "A String", # Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.
 }
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
index 455cf896e3..d6c304fd93 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
@@ -153,6 +153,7 @@ 
Method Details

     "a_key": "A String",
   },
   "logRetentionDays": "A String", # Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+  "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
   "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
   "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
   "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
@@ -283,6 +284,7 @@ 
Method Details

     "a_key": "A String",
   },
   "logRetentionDays": "A String", # Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+  "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
   "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
   "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
   "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
@@ -353,6 +355,7 @@ 
Method Details

         "a_key": "A String",
       },
       "logRetentionDays": "A String", # Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+      "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
       "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
       "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
       "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
@@ -432,6 +435,7 @@ 
Method Details

     "a_key": "A String",
   },
   "logRetentionDays": "A String", # Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+  "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
   "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
   "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
   "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html
index 0e4ce9900e..17b3c6cf22 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html
@@ -145,6 +145,7 @@ 
Method Details

       "a_key": "A String",
     },
     "logRetentionDays": "A String", # Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+    "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
     "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
     "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
     "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
@@ -219,6 +220,7 @@ 
Method Details

           "a_key": "A String",
         },
         "logRetentionDays": "A String", # Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
+        "maxCustomOnDemandRetentionDays": 42, # Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.
         "name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
         "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
         "revisionId": "A String", # Output only. The user friendly revision ID of the `BackupPlanRevision`. Example: v0, v1, v2, etc.
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
index 16bfd0bce2..53d88d4d55 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
@@ -80,6 +80,12 @@ 
Instance Methods

 

   delete(name, requestId=None, x__xgafv=None)

 
Deletes a Backup.

+

+  fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, view=None, x__xgafv=None)

+
Fetch Backups for a given resource type.

+

+  fetchForResourceType_next()

+
Retrieves the next page of results.

 

   get(name, view=None, x__xgafv=None)

 
Gets details of a Backup.

@@ -137,6 +143,302 @@ 
Method Details

 }
+
+ fetchForResourceType(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, resourceType=None, view=None, x__xgafv=None) + 
Fetch Backups for a given resource type.
+
+Args:
+  parent: string, Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId} (required)
+  filter: string, Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
+  pageSize: integer, Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token.
+  resourceType: string, Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance
+  view: string, Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.
+    Allowed values
+      BACKUP_VIEW_UNSPECIFIED - If the value is not set, the default 'FULL' view is used.
+      BACKUP_VIEW_BASIC - Includes basic data about the Backup, but not the full contents.
+      BACKUP_VIEW_FULL - Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the FetchBackupsForResourceType method.
+  "backups": [ # The Backups from the specified parent.
+    { # Message describing a Backup object.
+      "alloyDbBackupProperties": { # AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . # Output only. AlloyDB specific backup properties.
+        "chainId": "A String", # Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR.
+        "databaseVersion": "A String", # Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken.
+        "description": "A String", # An optional text description for the backup.
+        "storedBytes": "A String", # Output only. Storage usage of this particular backup
+      },
+      "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties.
+        "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized).
+        "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing).
+        "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup.
+        "recoveryRangeStartTime": "A String", # Optional. The earliest timestamp of data available in this Backup.
+      },
+      "backupApplianceLocks": [ # Optional. The list of BackupLocks taken by the accessor Backup Appliance.
+        { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+          "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+            "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+            "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+            "backupImage": "A String", # The image name that depends on this Backup.
+            "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+            "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+            "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+          },
+          "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+          "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+            "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+          },
+        },
+      ],
+      "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand.
+      "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
+        "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
+        "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+        "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+        "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
+        "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+        "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
+      },
+      "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties.
+        "canIpForward": True or False, # Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
+        "description": "A String", # An optional text description for the instances that are created from these properties.
+        "disk": [ # An array of disks that are associated with the instances that are created from these properties.
+          { # An instance-attached disk resource.
+            "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
+            "deviceName": "A String", # Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
+            "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
+              "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS.
+              "kmsKeyServiceAccount": "A String", # Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.
+              "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key.
+              "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.
+            },
+            "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
+            "diskSizeGb": "A String", # Optional. The size of the disk in GB.
+            "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
+            "diskTypeDeprecated": "A String", # Specifies the type of the disk.
+            "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
+              { # Feature type of the Guest OS.
+                "type": "A String", # The ID of a supported feature.
+              },
+            ],
+            "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
+            "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk.
+              "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.
+              "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
+                "A String",
+              ],
+            },
+            "kind": "A String", # Optional. Type of the resource.
+            "license": [ # Optional. Any valid publicly visible licenses.
+              "A String",
+            ],
+            "mode": "A String", # Optional. The mode in which to attach this disk.
+            "savedState": "A String", # Optional. Output only. The state of the disk.
+            "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
+            "type": "A String", # Optional. Specifies the type of the disk.
+          },
+        ],
+        "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties.
+          { # A specification of the type and number of accelerator cards attached to the instance.
+            "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance.
+            "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance.
+          },
+        ],
+        "keyRevocationActionType": "A String", # KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
+        "labels": { # Labels to apply to instances that are created from these properties.
+          "a_key": "A String",
+        },
+        "machineType": "A String", # The machine type to use for instances that are created from these properties.
+        "metadata": { # A metadata key/value entry. # The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
+          "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
+            { # A key/value pair to be used for storing metadata.
+              "key": "A String", # Optional. Key for the metadata entry.
+              "value": "A String", # Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).
+            },
+          ],
+        },
+        "minCpuPlatform": "A String", # Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
+        "networkInterface": [ # An array of network access configurations for this interface.
+          { # A network interface resource attached to an instance. s
+            "accessConfigs": [ # Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
+              { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+                "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+                "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+                "name": "A String", # Optional. The name of this access configuration.
+                "natIP": "A String", # Optional. The external IP address of this access configuration.
+                "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+                "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+                "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+                "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+              },
+            ],
+            "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
+              { # An alias IP range attached to an instance's network interface.
+                "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface.
+                "subnetworkRangeName": "A String", # Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
+              },
+            ],
+            "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range.
+            "ipv6AccessConfigs": [ # Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
+              { # An access configuration attached to an instance's network interface. Only one access config per instance is supported.
+                "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration.
+                "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range.
+                "name": "A String", # Optional. The name of this access configuration.
+                "natIP": "A String", # Optional. The external IP address of this access configuration.
+                "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access
+                "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record.
+                "setPublicPtr": True or False, # Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
+                "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
+              },
+            ],
+            "ipv6AccessType": "A String", # Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
+            "ipv6Address": "A String", # Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
+            "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server.
+            "network": "A String", # Optional. URL of the VPC network resource for this instance.
+            "networkAttachment": "A String", # Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
+            "networkIP": "A String", # Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
+            "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
+            "queueCount": 42, # Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
+            "stackType": "A String", # The stack type for this network interface.
+            "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance.
+          },
+        ],
+        "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties.
+          "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
+          "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance.
+          "localSsdRecoveryTimeout": { # A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
+            "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution.
+            "seconds": "A String", # Optional. Span of time at a resolution of a second.
+          },
+          "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
+          "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
+            { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
+              "key": "A String", # Optional. Corresponds to the label key of Node resource.
+              "operator": "A String", # Optional. Defines the operation of node selection.
+              "values": [ # Optional. Corresponds to the label values of Node resource.
+                "A String",
+              ],
+            },
+          ],
+          "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance.
+          "preemptible": True or False, # Optional. Defines whether the instance is preemptible.
+          "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance.
+        },
+        "serviceAccount": [ # A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
+          { # A service account.
+            "email": "A String", # Optional. Email address of the service account.
+            "scopes": [ # Optional. The list of scopes to be made available for this service account.
+              "A String",
+            ],
+          },
+        ],
+        "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
+        "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
+          "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
+            "A String",
+          ],
+        },
+      },
+      "consistencyTime": "A String", # Output only. The point in time when this backup was captured from the source.
+      "createTime": "A String", # Output only. The time when the instance was created.
+      "description": "A String", # Output only. The description of the Backup instance (2048 characters or less).
+      "diskBackupProperties": { # DiskBackupProperties represents the properties of a Disk backup. # Output only. Disk specific backup properties.
+        "accessMode": "A String", # The access mode of the source disk.
+        "architecture": "A String", # The architecture of the source disk. Valid values are ARM64 or X86_64.
+        "description": "A String", # A description of the source disk.
+        "enableConfidentialCompute": True or False, # Indicates whether the source disk is using confidential compute mode.
+        "guestOsFeature": [ # A list of guest OS features that are applicable to this backup.
+          { # Feature type of the Guest OS.
+            "type": "A String", # The ID of a supported feature.
+          },
+        ],
+        "labels": { # The labels of the source disk.
+          "a_key": "A String",
+        },
+        "licenses": [ # A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.
+          "A String",
+        ],
+        "physicalBlockSizeBytes": "A String", # The physical block size of the source disk.
+        "provisionedIops": "A String", # The number of IOPS provisioned for the source disk.
+        "provisionedThroughput": "A String", # The number of throughput provisioned for the source disk.
+        "region": "A String", # Region and zone are mutually exclusive fields. The URL of the region of the source disk.
+        "replicaZones": [ # The URL of the Zones where the source disk should be replicated.
+          "A String",
+        ],
+        "sizeGb": "A String", # Size(in GB) of the source disk.
+        "sourceDisk": "A String", # The source disk used to create this backup.
+        "storagePool": "A String", # The storage pool of the source disk.
+        "type": "A String", # The URL of the type of the disk.
+        "zone": "A String", # The URL of the Zone where the source disk.
+      },
+      "enforcedRetentionEndTime": "A String", # Optional. The backup can not be deleted before this time.
+      "etag": "A String", # Optional. Server specified ETag to prevent updates from overwriting each other.
+      "expireTime": "A String", # Optional. When this backup is automatically expired.
+      "gcpBackupPlanInfo": { # GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. # Output only. Configuration for a Google Cloud resource.
+        "backupPlan": "A String", # Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
+        "backupPlanRevisionId": "A String", # The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.
+        "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
+        "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
+      },
+      "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+        "gcpResourcename": "A String", # Name of the Google Cloud resource.
+        "location": "A String", # Location of the resource: //"global"/"unspecified".
+        "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+      },
+      "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
+      "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+      "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+      "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
+      "serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
+        { # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
+          "backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
+            "backupApplianceId": "A String", # Required. The ID of the backup/recovery appliance that created this lock.
+            "backupApplianceName": "A String", # Required. The name of the backup/recovery appliance that created this lock.
+            "backupImage": "A String", # The image name that depends on this Backup.
+            "jobName": "A String", # The job name on the backup/recovery appliance that created this lock.
+            "lockReason": "A String", # Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.
+            "slaId": "A String", # The SLA on the backup/recovery appliance that owns the lock.
+          },
+          "lockUntilTime": "A String", # Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.
+          "serviceLockInfo": { # ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. # Output only. Contains metadata about the lock exist for Google Cloud native backups.
+            "operation": "A String", # Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.
+          },
+        },
+      ],
+      "state": "A String", # Output only. The Backup resource instance state.
+      "updateTime": "A String", # Output only. The time when the instance was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ fetchForResourceType_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+
get(name, view=None, x__xgafv=None) 
Gets details of a Backup.
@@ -189,6 +491,8 @@ 
Method Details

   "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
     "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
     "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+    "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+    "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
     "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
     "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
   },
@@ -374,6 +678,11 @@ 
Method Details

     "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
     "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
   },
+  "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+    "gcpResourcename": "A String", # Name of the Google Cloud resource.
+    "location": "A String", # Location of the resource: //"global"/"unspecified".
+    "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+  },
   "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
     "a_key": "A String",
   },
@@ -460,6 +769,8 @@ 
Method Details

       "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
         "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
         "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+        "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+        "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
         "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
         "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
       },
@@ -645,6 +956,11 @@ 
Method Details

         "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
         "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
       },
+      "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+        "gcpResourcename": "A String", # Name of the Google Cloud resource.
+        "location": "A String", # Location of the resource: //"global"/"unspecified".
+        "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+      },
       "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
         "a_key": "A String",
       },
@@ -735,6 +1051,8 @@ 
Method Details

   "cloudSqlInstanceBackupProperties": { # CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. # Output only. Cloud SQL specific backup properties.
     "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance when the backup was taken.
     "finalBackup": True or False, # Output only. Whether the backup is a final backup.
+    "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+    "instanceDeleteTime": "A String", # Output only. The instance delete timestamp.
     "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
     "sourceInstance": "A String", # Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
   },
@@ -920,6 +1238,11 @@ 
Method Details

     "backupPlanRevisionName": "A String", # Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
     "backupPlanRuleId": "A String", # The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
   },
+  "gcpResource": { # Minimum details to identify a Google Cloud resource for a backup. # Output only. Unique identifier of the GCP resource that is being backed up.
+    "gcpResourcename": "A String", # Name of the Google Cloud resource.
+    "location": "A String", # Location of the resource: //"global"/"unspecified".
+    "type": "A String", # Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.
+  },
   "labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined.
     "a_key": "A String",
   },
diff --git a/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html b/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html
index b50cdbf60d..14ddc79b8b 100644
--- a/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html
+++ b/docs/dyn/backupdr_v1.projects.locations.dataSourceReferences.html
@@ -86,6 +86,12 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Gets details of a single DataSourceReference.

+

+  list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists DataSourceReferences for a given project and location.

+

+  list_next()

+
Retrieves the next page of results.

 
Method Details

 

     close()
@@ -134,6 +140,7 @@ 
Method Details

         "type": "A String", # Output only. The type of the GCP resource. Ex: compute.googleapis.com/Instance
       },
       "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
+      "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource.
     },
   ],
   "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
@@ -189,7 +196,70 @@ 
Method Details

     "type": "A String", # Output only. The type of the GCP resource. Ex: compute.googleapis.com/Instance
   },
   "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
+  "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource.
 }
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists DataSourceReferences for a given project and location.
+
+Args:
+  parent: string, Required. The parent resource name. Format: projects/{project}/locations/{location} (required)
+  filter: string, Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename
+  pageSize: integer, Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
+  pageToken: string, Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the ListDataSourceReferences method.
+  "dataSourceReferences": [ # The DataSourceReferences from the specified parent.
+    { # DataSourceReference is a reference to a DataSource resource.
+      "createTime": "A String", # Output only. The time when the DataSourceReference was created.
+      "dataSource": "A String", # Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource}
+      "dataSourceBackupConfigInfo": { # Information of backup configuration on the DataSource. # Output only. Information of backup configuration on the DataSource.
+        "lastBackupState": "A String", # Output only. The status of the last backup in this DataSource
+        "lastSuccessfulBackupConsistencyTime": "A String", # Output only. Timestamp of the last successful backup to this DataSource.
+      },
+      "dataSourceBackupConfigState": "A String", # Output only. The backup configuration state of the DataSource.
+      "dataSourceBackupCount": "A String", # Output only. Number of backups in the DataSource.
+      "dataSourceGcpResourceInfo": { # The GCP resource that the DataSource is associated with. # Output only. The GCP resource that the DataSource is associated with.
+        "cloudSqlInstanceProperties": { # CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference. # Output only. The properties of the Cloud SQL instance.
+          "databaseInstalledVersion": "A String", # Output only. The installed database version of the Cloud SQL instance.
+          "instanceCreateTime": "A String", # Output only. The instance creation timestamp.
+          "instanceTier": "A String", # Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`
+          "name": "A String", # Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
+        },
+        "gcpResourcename": "A String", # Output only. The resource name of the GCP resource. Ex: projects/{project}/zones/{zone}/instances/{instance}
+        "location": "A String", # Output only. The location of the GCP resource. Ex: //"global"/"unspecified"
+        "type": "A String", # Output only. The type of the GCP resource. Ex: compute.googleapis.com/Instance
+      },
+      "name": "A String", # Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
+      "totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources for the referenced datasource.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ \ No newline at end of file diff --git a/docs/dyn/backupdr_v1.projects.locations.html b/docs/dyn/backupdr_v1.projects.locations.html index 6767c8b884..a081268202 100644 --- a/docs/dyn/backupdr_v1.projects.locations.html +++ b/docs/dyn/backupdr_v1.projects.locations.html @@ -196,7 +196,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 2746c55069..6c0365fec6 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1363,6 +1363,72 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"fetchForResourceType": { +"description": "Fetch Backups for a given resource type.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups:fetchForResourceType", +"httpMethod": "GET", +"id": "backupdr.projects.locations.backupVaults.dataSources.backups.fetchForResourceType", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", +"required": true, +"type": "string" +}, +"resourceType": { +"description": "Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance", +"location": "query", +"type": "string" +}, +"view": { +"description": "Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.", +"enum": [ +"BACKUP_VIEW_UNSPECIFIED", +"BACKUP_VIEW_BASIC", +"BACKUP_VIEW_FULL" +], +"enumDescriptions": [ +"If the value is not set, the default 'FULL' view is used.", +"Includes basic data about the Backup, but not the full contents.", +"Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/backups:fetchForResourceType", +"response": { +"$ref": "FetchBackupsForResourceTypeResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "Gets details of a Backup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", @@ -1614,6 +1680,52 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"list": { +"description": "Lists DataSourceReferences for a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSourceReferences", +"httpMethod": "GET", +"id": "backupdr.projects.locations.dataSourceReferences.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/dataSourceReferences", +"response": { +"$ref": "ListDataSourceReferencesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -2122,7 +2234,7 @@ } } }, -"revision": "20251001", +"revision": "20251022", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2602,6 +2714,11 @@ "description": "Output only. Configuration for a Google Cloud resource.", "readOnly": true }, +"gcpResource": { +"$ref": "BackupGcpResource", +"description": "Output only. Unique identifier of the GCP resource that is being backed up.", +"readOnly": true +}, "labels": { "additionalProperties": { "type": "string" @@ -2950,6 +3067,25 @@ }, "type": "object" }, +"BackupGcpResource": { +"description": "Minimum details to identify a Google Cloud resource for a backup.", +"id": "BackupGcpResource", +"properties": { +"gcpResourcename": { +"description": "Name of the Google Cloud resource.", +"type": "string" +}, +"location": { +"description": "Location of the resource: //\"global\"/\"unspecified\".", +"type": "string" +}, +"type": { +"description": "Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", +"type": "string" +} +}, +"type": "object" +}, "BackupLocation": { "description": "BackupLocation represents a cloud location where a backup can be stored.", "id": "BackupLocation", @@ -3046,6 +3182,11 @@ "format": "int64", "type": "string" }, +"maxCustomOnDemandRetentionDays": { +"description": "Optional. Optional field to configure the maximum number of days for which a backup can be retained. This field is only applicable for on-demand backups taken with custom retention value.", +"format": "int32", +"type": "integer" +}, "name": { "description": "Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", "readOnly": true, @@ -3448,6 +3589,18 @@ "readOnly": true, "type": "boolean" }, +"instanceCreateTime": { +"description": "Output only. The instance creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"instanceDeleteTime": { +"description": "Output only. The instance delete timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "instanceTier": { "description": "Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`", "readOnly": true, @@ -4132,6 +4285,12 @@ "name": { "description": "Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}", "type": "string" +}, +"totalStoredBytes": { +"description": "Output only. Total size of the storage used by all backup resources for the referenced datasource.", +"format": "int64", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -4501,6 +4660,24 @@ }, "type": "object" }, +"FetchBackupsForResourceTypeResponse": { +"description": "Response for the FetchBackupsForResourceType method.", +"id": "FetchBackupsForResourceTypeResponse", +"properties": { +"backups": { +"description": "The Backups from the specified parent.", +"items": { +"$ref": "Backup" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "FetchDataSourceReferencesForResourceTypeResponse": { "description": "Response for the FetchDataSourceReferencesForResourceType method.", "id": "FetchDataSourceReferencesForResourceTypeResponse", @@ -4938,6 +5115,24 @@ }, "type": "object" }, +"ListDataSourceReferencesResponse": { +"description": "Response for the ListDataSourceReferences method.", +"id": "ListDataSourceReferencesResponse", +"properties": { +"dataSourceReferences": { +"description": "The DataSourceReferences from the specified parent.", +"items": { +"$ref": "DataSourceReference" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "ListDataSourcesResponse": { "description": "Response message for listing DataSources.", "id": "ListDataSourcesResponse", @@ -6195,6 +6390,11 @@ "description": "Request message for triggering a backup.", "id": "TriggerBackupRequest", "properties": { +"customRetentionDays": { +"description": "Optional. The duration for which backup data will be kept, while taking an on-demand backup with custom retention. It is defined in \"days\". It is mutually exclusive with rule_id. This field is required if rule_id is not provided.", +"format": "int32", +"type": "integer" +}, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" From f598d38025c1515b5e615f8437a64cbd43fed135 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:10 +0000 Subject: [PATCH 13/70] feat(biglake): update the api #### biglake:v1 The following keys were added: - resources.projects.resources.catalogs.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.catalogs.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.catalogs.resources.namespaces.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.catalogs.resources.namespaces.methods.setIamPolicy (Total Keys: 12) - schemas.AuditConfig (Total Keys: 5) - schemas.AuditLogConfig (Total Keys: 5) - schemas.Binding (Total Keys: 6) - schemas.Expr (Total Keys: 4) - schemas.Policy (Total Keys: 8) - schemas.SetIamPolicyRequest (Total Keys: 5) --- docs/dyn/biglake_v1.projects.catalogs.html | 230 +++++++++++++++ ...glake_v1.projects.catalogs.namespaces.html | 225 ++++++++++++++ docs/dyn/biglake_v1.projects.html | 5 + .../discovery_cache/documents/biglake.v1.json | 274 +++++++++++++++++- 4 files changed, 733 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/biglake_v1.projects.catalogs.html create mode 100644 docs/dyn/biglake_v1.projects.catalogs.namespaces.html diff --git a/docs/dyn/biglake_v1.projects.catalogs.html b/docs/dyn/biglake_v1.projects.catalogs.html new file mode 100644 index 0000000000..cb5932bea5 --- /dev/null +++ b/docs/dyn/biglake_v1.projects.catalogs.html @@ -0,0 +1,230 @@ + + + +

BigLake API . projects . catalogs

+

Instance Methods

+

+ namespaces() +

+

Returns the namespaces Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the IAM policy for the specified Catalog.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the IAM policy for the specified catalog.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) + 
Gets the IAM policy for the specified Catalog.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # 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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # 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`.
+        "A String",
+      ],
+      "role": "A String", # 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).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) + 
Sets the IAM policy for the specified catalog.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # 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.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # 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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # 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`.
+          "A String",
+        ],
+        "role": "A String", # 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).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # 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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # 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`.
+        "A String",
+      ],
+      "role": "A String", # 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).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/biglake_v1.projects.catalogs.namespaces.html b/docs/dyn/biglake_v1.projects.catalogs.namespaces.html new file mode 100644 index 0000000000..76b5d3a1a5 --- /dev/null +++ b/docs/dyn/biglake_v1.projects.catalogs.namespaces.html @@ -0,0 +1,225 @@ + + + +

BigLake API . projects . catalogs . namespaces

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

+

Gets the IAM policy for the specified Catalog.

+

+ setIamPolicy(resource, body=None, x__xgafv=None)

+

Sets the IAM policy for the specified catalog.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None) + 
Gets the IAM policy for the specified Catalog.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # 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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # 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`.
+        "A String",
+      ],
+      "role": "A String", # 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).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ setIamPolicy(resource, body=None, x__xgafv=None) + 
Sets the IAM policy for the specified catalog.
+
+Args:
+  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+    "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+      { # 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.
+        "auditLogConfigs": [ # The configuration for logging of each type of permission.
+          { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+            "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+              "A String",
+            ],
+            "logType": "A String", # The log type that this config enables.
+          },
+        ],
+        "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+      },
+    ],
+    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+      { # Associates `members`, or principals, with a `role`.
+        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # 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).
+          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+        },
+        "members": [ # 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`.
+          "A String",
+        ],
+        "role": "A String", # 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).
+      },
+    ],
+    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
+  "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+    { # 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.
+      "auditLogConfigs": [ # The configuration for logging of each type of permission.
+        { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+          "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+            "A String",
+          ],
+          "logType": "A String", # The log type that this config enables.
+        },
+      ],
+      "service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
+    },
+  ],
+  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
+    { # Associates `members`, or principals, with a `role`.
+      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # 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).
+        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+      },
+      "members": [ # 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`.
+        "A String",
+      ],
+      "role": "A String", # 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).
+    },
+  ],
+  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
+  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/biglake_v1.projects.html b/docs/dyn/biglake_v1.projects.html index a01b91f2da..f017207767 100644 --- a/docs/dyn/biglake_v1.projects.html +++ b/docs/dyn/biglake_v1.projects.html @@ -74,6 +74,11 @@

BigLake API . projects

Instance Methods

+

+ catalogs() +

+

Returns the catalogs Resource.

+

locations()

diff --git a/googleapiclient/discovery_cache/documents/biglake.v1.json b/googleapiclient/discovery_cache/documents/biglake.v1.json index 3fe9cc2f50..41c5b57da0 100644 --- a/googleapiclient/discovery_cache/documents/biglake.v1.json +++ b/googleapiclient/discovery_cache/documents/biglake.v1.json @@ -110,6 +110,138 @@ "resources": { "projects": { "resources": { +"catalogs": { +"methods": { +"getIamPolicy": { +"description": "Gets the IAM policy for the specified Catalog.", +"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:getIamPolicy", +"httpMethod": "GET", +"id": "biglake.projects.catalogs.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/catalogs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the IAM policy for the specified catalog.", +"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}:setIamPolicy", +"httpMethod": "POST", +"id": "biglake.projects.catalogs.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/catalogs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"namespaces": { +"methods": { +"getIamPolicy": { +"description": "Gets the IAM policy for the specified Catalog.", +"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:getIamPolicy", +"httpMethod": "GET", +"id": "biglake.projects.catalogs.namespaces.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"setIamPolicy": { +"description": "Sets the IAM policy for the specified catalog.", +"flatPath": "v1/projects/{projectsId}/catalogs/{catalogsId}/namespaces/{namespacesId}:setIamPolicy", +"httpMethod": "POST", +"id": "biglake.projects.catalogs.namespaces.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/catalogs/[^/]+/namespaces/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "locations": { "resources": { "catalogs": { @@ -616,9 +748,79 @@ } } }, -"revision": "20250722", +"revision": "20251027", "rootUrl": "https://biglake.googleapis.com/", "schemas": { +"AuditConfig": { +"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", +"id": "AuditConfig", +"properties": { +"auditLogConfigs": { +"description": "The configuration for logging of each type of permission.", +"items": { +"$ref": "AuditLogConfig" +}, +"type": "array" +}, +"service": { +"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", +"type": "string" +} +}, +"type": "object" +}, +"AuditLogConfig": { +"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", +"id": "AuditLogConfig", +"properties": { +"exemptedMembers": { +"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", +"items": { +"type": "string" +}, +"type": "array" +}, +"logType": { +"description": "The log type that this config enables.", +"enum": [ +"LOG_TYPE_UNSPECIFIED", +"ADMIN_READ", +"DATA_WRITE", +"DATA_READ" +], +"enumDescriptions": [ +"Default case. Should never be this.", +"Admin reads. Example: CloudIAM getIamPolicy", +"Data writes. Example: CloudSQL Users create", +"Data reads. Example: CloudSQL Users list" +], +"type": "string" +} +}, +"type": "object" +}, +"Binding": { +"description": "Associates `members`, or principals, with a `role`.", +"id": "Binding", +"properties": { +"condition": { +"$ref": "Expr", +"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." +}, +"members": { +"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"role": { +"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", +"type": "string" +} +}, +"type": "object" +}, "Catalog": { "description": "Catalog is the container of databases.", "id": "Catalog", @@ -707,6 +909,29 @@ }, "type": "object" }, +"Expr": { +"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", +"id": "Expr", +"properties": { +"description": { +"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", +"type": "string" +}, +"expression": { +"description": "Textual representation of an expression in Common Expression Language syntax.", +"type": "string" +}, +"location": { +"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", +"type": "string" +}, +"title": { +"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", +"type": "string" +} +}, +"type": "object" +}, "HiveDatabaseOptions": { "description": "Options of a Hive database.", "id": "HiveDatabaseOptions", @@ -801,6 +1026,37 @@ }, "type": "object" }, +"Policy": { +"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", +"id": "Policy", +"properties": { +"auditConfigs": { +"description": "Specifies cloud audit logging configuration for this policy.", +"items": { +"$ref": "AuditConfig" +}, +"type": "array" +}, +"bindings": { +"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", +"items": { +"$ref": "Binding" +}, +"type": "array" +}, +"etag": { +"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", +"format": "byte", +"type": "string" +}, +"version": { +"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "RenameTableRequest": { "description": "Request message for the RenameTable method in MetastoreService", "id": "RenameTableRequest", @@ -823,6 +1079,22 @@ }, "type": "object" }, +"SetIamPolicyRequest": { +"description": "Request message for `SetIamPolicy` method.", +"id": "SetIamPolicyRequest", +"properties": { +"policy": { +"$ref": "Policy", +"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." +}, +"updateMask": { +"description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, "StorageDescriptor": { "description": "Stores physical storage information of the data.", "id": "StorageDescriptor", From cee5b00a8ea42682301ccd82abb987ca985520b1 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:10 +0000 Subject: [PATCH 14/70] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.IndexPruningStats.properties.indexId.type (Total Keys: 1) --- docs/dyn/bigquery_v2.jobs.html | 5 +++++ googleapiclient/discovery_cache/documents/bigquery.v2.json | 6 +++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 080b3c19b2..95141f8121 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -1421,6 +1421,7 @@

Method Details

"projectId": "A String", # Required. The ID of the project containing this table. "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. }, + "indexId": "A String", # The index id. "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. }, @@ -2934,6 +2935,7 @@

Method Details

"projectId": "A String", # Required. The ID of the project containing this table. "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. }, + "indexId": "A String", # The index id. "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. }, @@ -4535,6 +4537,7 @@

Method Details

"projectId": "A String", # Required. The ID of the project containing this table. "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. }, + "indexId": "A String", # The index id. "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. }, @@ -6019,6 +6022,7 @@

Method Details

"projectId": "A String", # Required. The ID of the project containing this table. "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. }, + "indexId": "A String", # The index id. "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. }, @@ -7528,6 +7532,7 @@

Method Details

"projectId": "A String", # Required. The ID of the project containing this table. "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. }, + "indexId": "A String", # The index id. "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. }, diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 8d05d006b0..246eb38928 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2375,7 +2375,7 @@ } } }, -"revision": "20250928", +"revision": "20251012", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -5185,6 +5185,10 @@ "$ref": "TableReference", "description": "The base table reference." }, +"indexId": { +"description": "The index id.", +"type": "string" +}, "postIndexPruningParallelInputCount": { "description": "The number of parallel inputs after index pruning.", "format": "int64", From 8dd81b0b258535afa8a6da984cd62f53892f7754 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:10 +0000 Subject: [PATCH 15/70] feat(bigquerydatatransfer): update the api #### bigquerydatatransfer:v1 The following keys were added: - schemas.TransferConfig.properties.managedTableType.type (Total Keys: 1) --- ...er_v1.projects.locations.transferConfigs.html | 6 ++++++ ...datatransfer_v1.projects.transferConfigs.html | 6 ++++++ .../documents/bigquerydatatransfer.v1.json | 16 +++++++++++++++- 3 files changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html index 2a4c648fc6..cac4e709c9 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html @@ -143,6 +143,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -208,6 +209,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -295,6 +297,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -370,6 +373,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -450,6 +454,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -516,6 +521,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html index ea0b820a9e..e70c99cd90 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html @@ -143,6 +143,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -208,6 +209,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -295,6 +297,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -370,6 +373,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -450,6 +454,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` @@ -516,6 +521,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, + "managedTableType": "A String", # The classification of the destination table. "name": "A String", # Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. "nextRunTime": "A String", # Output only. Next time when data transfer will run. "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index a082935839..4649762dca 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1488,7 +1488,7 @@ } } }, -"revision": "20250906", +"revision": "20251020", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -2134,6 +2134,20 @@ "description": "Output only. Error code with detailed information about reason of the latest config failure.", "readOnly": true }, +"managedTableType": { +"description": "The classification of the destination table.", +"enum": [ +"MANAGED_TABLE_TYPE_UNSPECIFIED", +"NATIVE", +"BIGLAKE" +], +"enumDescriptions": [ +"Type unspecified. This defaults to `NATIVE` table.", +"The managed table is a native BigQuery table. This is the default value.", +"The managed table is a BigQuery table for Apache Iceberg (formerly BigLake managed tables), with a BigLake configuration." +], +"type": "string" +}, "name": { "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.", "type": "string" From c0b2205c2dbc816c783d5d9da64aa8f01ac64976 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:10 +0000 Subject: [PATCH 16/70] feat(chat): update the api #### chat:v1 The following keys were added: - schemas.PermissionSetting.properties.assistantManagersAllowed.type (Total Keys: 1) --- docs/dyn/chat_v1.spaces.html | 110 ++++++- docs/dyn/chat_v1.spaces.messages.html | 176 ++++++---- docs/dyn/chat_v1.spaces.spaceEvents.html | 304 +++++++++++++----- .../discovery_cache/documents/chat.v1.json | 18 +- 4 files changed, 447 insertions(+), 161 deletions(-) diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index a135b042fa..9692400d06 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -159,7 +159,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -172,34 +172,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -235,7 +243,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -248,34 +256,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -310,7 +326,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -323,34 +339,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -410,7 +434,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -423,34 +447,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -492,7 +524,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -505,34 +537,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -578,7 +618,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -591,34 +631,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -670,7 +718,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -683,34 +731,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -746,7 +802,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -759,34 +815,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -834,7 +898,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -847,34 +911,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -947,7 +1019,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -960,34 +1032,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -1022,7 +1102,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -1035,34 +1115,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 3df2d5d05c..d4f71a4585 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -362,7 +362,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -652,7 +652,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1224,7 +1224,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1514,7 +1514,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2299,7 +2299,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2589,7 +2589,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2970,7 +2970,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -2983,34 +2983,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -3291,7 +3299,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -3581,7 +3589,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4153,7 +4161,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4443,7 +4451,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5228,7 +5236,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5518,7 +5526,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5899,7 +5907,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -5912,34 +5920,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -6238,7 +6254,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -6528,7 +6544,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7100,7 +7116,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7390,7 +7406,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8175,7 +8191,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8465,7 +8481,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8846,7 +8862,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -8859,34 +8875,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -9173,7 +9197,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -9463,7 +9487,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10035,7 +10059,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10325,7 +10349,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11110,7 +11134,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11400,7 +11424,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11781,7 +11805,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -11794,34 +11818,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -12113,7 +12145,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -12403,7 +12435,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -12975,7 +13007,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -13265,7 +13297,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14050,7 +14082,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14340,7 +14372,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14721,7 +14753,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -14734,34 +14766,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -15036,7 +15076,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15326,7 +15366,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15898,7 +15938,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16188,7 +16228,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16973,7 +17013,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17263,7 +17303,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17644,7 +17684,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -17657,34 +17697,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -17959,7 +18007,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -18249,7 +18297,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -18821,7 +18869,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19111,7 +19159,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19896,7 +19944,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20186,7 +20234,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20567,7 +20615,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -20580,34 +20628,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -20882,7 +20938,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -21172,7 +21228,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -21744,7 +21800,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22034,7 +22090,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22819,7 +22875,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23109,7 +23165,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23490,7 +23546,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -23503,34 +23559,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index d55ca5e29d..d657148c4e 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -477,7 +477,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -767,7 +767,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1339,7 +1339,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -1629,7 +1629,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2414,7 +2414,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -2704,7 +2704,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -3085,7 +3085,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -3098,34 +3098,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -3395,7 +3403,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -3685,7 +3693,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4257,7 +4265,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -4547,7 +4555,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5332,7 +5340,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -5622,7 +5630,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -6003,7 +6011,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -6016,34 +6024,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -6313,7 +6329,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -6603,7 +6619,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7175,7 +7191,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -7465,7 +7481,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8250,7 +8266,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8540,7 +8556,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -8921,7 +8937,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -8934,34 +8950,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -9229,7 +9253,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -9519,7 +9543,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10091,7 +10115,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -10381,7 +10405,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11166,7 +11190,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11456,7 +11480,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -11837,7 +11861,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -11850,34 +11874,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -12143,7 +12175,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -12433,7 +12465,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -13005,7 +13037,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -13295,7 +13327,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14080,7 +14112,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14370,7 +14402,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -14751,7 +14783,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -14764,34 +14796,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -15057,7 +15097,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15347,7 +15387,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -15919,7 +15959,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16209,7 +16249,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -16994,7 +17034,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17284,7 +17324,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -17665,7 +17705,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -17678,34 +17718,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -17850,7 +17898,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -17863,34 +17911,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -17919,7 +17975,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -17932,34 +17988,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -18372,7 +18436,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -18662,7 +18726,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19234,7 +19298,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -19524,7 +19588,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20309,7 +20373,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20599,7 +20663,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -20980,7 +21044,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -20993,34 +21057,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -21290,7 +21362,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -21580,7 +21652,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22152,7 +22224,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -22442,7 +22514,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23227,7 +23299,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23517,7 +23589,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -23898,7 +23970,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -23911,34 +23983,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -24208,7 +24288,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -24498,7 +24578,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -25070,7 +25150,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -25360,7 +25440,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -26145,7 +26225,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -26435,7 +26515,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -26816,7 +26896,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -26829,34 +26909,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -27124,7 +27212,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -27414,7 +27502,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -27986,7 +28074,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -28276,7 +28364,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -29061,7 +29149,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -29351,7 +29439,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -29732,7 +29820,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -29745,34 +29833,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -30038,7 +30134,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -30328,7 +30424,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -30900,7 +30996,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -31190,7 +31286,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -31975,7 +32071,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -32265,7 +32361,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -32646,7 +32742,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -32659,34 +32755,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -32952,7 +33056,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -33242,7 +33346,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -33814,7 +33918,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -34104,7 +34208,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -34889,7 +34993,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -35179,7 +35283,7 @@

Method Details

}, "timezoneOffsetDate": 42, # The number representing the time zone offset from UTC, in minutes. If set, the `value_ms_epoch` is displayed in the specified time zone. If unset, the value defaults to the user's time zone setting. "type": "A String", # Whether the widget supports inputting a date, a time, or the date and time. - "valueMsEpoch": "A String", # Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). + "valueMsEpoch": "A String", # The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`). }, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. @@ -35560,7 +35664,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -35573,34 +35677,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -35745,7 +35857,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -35758,34 +35870,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, @@ -35814,7 +35934,7 @@

Method Details

}, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. - "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated. + "customer": "A String", # Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users. "displayName": "A String", # Optional. The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. "externalUserAllowed": True or False, # Optional. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). @@ -35827,34 +35947,42 @@

Method Details

"name": "A String", # Identifier. Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. "permissionSettings": { # [Permission settings](https://support.google.com/chat/answer/13340792) that you can specify when updating an existing named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. # Optional. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings. Reading and updating permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. Only populated and settable when the Chat app created the space. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "manageApps": { # Represents a space permission setting. # Optional. Setting for managing apps in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageMembersAndGroups": { # Represents a space permission setting. # Optional. Setting for managing members and groups in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "manageWebhooks": { # Represents a space permission setting. # Optional. Setting for managing webhooks in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "modifySpaceDetails": { # Represents a space permission setting. # Optional. Setting for updating space name, avatar, description and guidelines. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "postMessages": { # Represents a space permission setting. # Output only. Setting for posting messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "replyMessages": { # Represents a space permission setting. # Optional. Setting for replying to messages in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "toggleHistory": { # Represents a space permission setting. # Optional. Setting for toggling space history on and off. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, "useAtMentionAll": { # Represents a space permission setting. # Optional. Setting for using @all in a space. + "assistantManagersAllowed": True or False, # Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission. "managersAllowed": True or False, # Optional. Whether space owners (`ROLE_MANAGER`) have this permission. "membersAllowed": True or False, # Optional. Whether basic space members (`ROLE_MEMBER`) have this permission. }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 5fdea6d48a..f997c914fe 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1535,7 +1535,7 @@ } } }, -"revision": "20251014", +"revision": "20251029", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2243,7 +2243,7 @@ "enumDescriptions": [ "This value is unused.", "User deleted their own message.", -"A space manager deleted the message.", +"An owner or manager deleted the message.", "A Google Workspace administrator deleted the message. Administrators can delete any message in the space, including messages sent by any space member or Chat app.", "A Chat app deleted its own message when it expired.", "A Chat app deleted the message on behalf of the creator (using user authentication).", @@ -3041,7 +3041,7 @@ "type": "string" }, "valueMsEpoch": { -"description": "Optional. The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", +"description": "The default value displayed in the widget, in milliseconds since [Unix epoch time](https://en.wikipedia.org/wiki/Unix_time). Specify the value based on the type of picker (`DateTimePickerType`): * `DATE_AND_TIME`: a calendar date and time in UTC. For example, to represent January 1, 2023 at 12:00 PM UTC, use `1672574400000`. * `DATE_ONLY`: a calendar date at 00:00:00 UTC. For example, to represent January 1, 2023, use `1672531200000`. * `TIME_ONLY`: a time in UTC. For example, to represent 12:00 PM, use `43200000` (or `12 * 60 * 60 * 1000`).", "format": "int64", "type": "string" } @@ -4494,12 +4494,14 @@ "enum": [ "MEMBERSHIP_ROLE_UNSPECIFIED", "ROLE_MEMBER", -"ROLE_MANAGER" +"ROLE_MANAGER", +"ROLE_ASSISTANT_MANAGER" ], "enumDescriptions": [ "Default value. For users: they aren't a member of the space, but can be invited. For Google Groups: they're always assigned this role (other enum values might be used in the future).", "A member of the space. In the Chat UI, this role is called Member. The user has basic permissions, like sending messages to the space. Managers and owners can grant members additional permissions in a space, including: - Add or remove members. - Modify space details. - Turn history on or off. - Mention everyone in the space with `@all`. - Manage Chat apps and webhooks installed in the space. In direct messages and unnamed group conversations, everyone has this role.", -"A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: - Change the role of other members in the space to member, manager, or owner. - Delete the space. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Learn more about your role as a space owner or manager](https://support.google.com/chat/answer/11833441)." +"A space owner. In the Chat UI, this role is called Owner. The user has the complete set of space permissions to manage the space, including: - Change the role of other members in the space to member, manager, or owner. - Delete the space. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Learn more about your role as a space owner or manager](https://support.google.com/chat/answer/11833441).", +"A space manager. In the Chat UI, this role is called Manager. The user has all basic permissions of `ROLE_MEMBER`, and can be granted a subset of administrative permissions by an owner. By default, managers have all the permissions of an owner except for the ability to: - Delete the space. - Make another space member an owner. - Change an owner's role. By default, managers permissions include but aren't limited to: - Make another member a manager. - Delete messages in the space. - Manage space permissions. - Receive notifications for requests to join the space if the manager has the \"manage members\" permission in the space settings. - Make a space discoverable. Only supported in SpaceType.SPACE (named spaces). To learn more, see [Manage space settings](https://support.google.com/chat/answer/13340792)." ], "type": "string" }, @@ -4871,6 +4873,10 @@ "description": "Represents a space permission setting.", "id": "PermissionSetting", "properties": { +"assistantManagersAllowed": { +"description": "Optional. Whether space managers `ROLE_ASSISTANT_MANAGER`) have this permission.", +"type": "boolean" +}, "managersAllowed": { "description": "Optional. Whether space owners (`ROLE_MANAGER`) have this permission.", "type": "boolean" @@ -5199,7 +5205,7 @@ "type": "string" }, "customer": { -"description": "Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. For DMs, this field isn't populated.", +"description": "Optional. Immutable. The customer id of the domain of the space. Required only when creating a space with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and `SpaceType` is `SPACE`, otherwise should not be set. In the format `customers/{customer}`, where `customer` is the `id` from the [Admin SDK customer resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Private apps can also use the `customers/my_customer` alias to create the space in the same Google Workspace organization as the app. This field isn't populated for direct messages (DMs) or when the space is created by non-Google Workspace users.", "type": "string" }, "displayName": { From c40d929e0a719ba2f756c5e076edaafe97f0ade8 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:10 +0000 Subject: [PATCH 17/70] feat(cloudfunctions): update the api #### cloudfunctions:v2alpha The following keys were added: - schemas.DirectVpcNetworkInterface (Total Keys: 6) - schemas.ServiceConfig.properties.directVpcEgress.type (Total Keys: 1) - schemas.ServiceConfig.properties.directVpcNetworkInterface (Total Keys: 2) #### cloudfunctions:v2beta The following keys were added: - schemas.DirectVpcNetworkInterface (Total Keys: 6) - schemas.ServiceConfig.properties.directVpcEgress.type (Total Keys: 1) - schemas.ServiceConfig.properties.directVpcNetworkInterface (Total Keys: 2) --- .../cloudfunctions_v1.projects.locations.html | 2 +- .../cloudfunctions_v2.projects.locations.html | 2 +- ..._v2alpha.projects.locations.functions.html | 80 +++++++++++++++++++ ...dfunctions_v2alpha.projects.locations.html | 2 +- ...s_v2beta.projects.locations.functions.html | 80 +++++++++++++++++++ ...udfunctions_v2beta.projects.locations.html | 2 +- .../documents/cloudfunctions.v1.json | 4 +- .../documents/cloudfunctions.v2.json | 4 +- .../documents/cloudfunctions.v2alpha.json | 47 ++++++++++- .../documents/cloudfunctions.v2beta.json | 47 ++++++++++- 10 files changed, 258 insertions(+), 12 deletions(-) diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.html b/docs/dyn/cloudfunctions_v1.projects.locations.html index 87dd68140a..b35d255b4c 100644 --- a/docs/dyn/cloudfunctions_v1.projects.locations.html +++ b/docs/dyn/cloudfunctions_v1.projects.locations.html @@ -100,7 +100,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.html b/docs/dyn/cloudfunctions_v2.projects.locations.html index 2c61beb635..e08cc4f21c 100644 --- a/docs/dyn/cloudfunctions_v2.projects.locations.html +++ b/docs/dyn/cloudfunctions_v2.projects.locations.html @@ -110,7 +110,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html index af378adce7..256c7efb48 100644 --- a/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html @@ -310,6 +310,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -431,6 +441,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -737,6 +757,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -858,6 +888,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1054,6 +1094,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1175,6 +1225,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1332,6 +1392,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1453,6 +1523,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, diff --git a/docs/dyn/cloudfunctions_v2alpha.projects.locations.html b/docs/dyn/cloudfunctions_v2alpha.projects.locations.html index e8ab65ca64..153f4327ee 100644 --- a/docs/dyn/cloudfunctions_v2alpha.projects.locations.html +++ b/docs/dyn/cloudfunctions_v2alpha.projects.locations.html @@ -110,7 +110,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html index 0fedcca2af..224b908302 100644 --- a/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html @@ -310,6 +310,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -431,6 +441,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -737,6 +757,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -858,6 +888,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1054,6 +1094,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1175,6 +1225,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1332,6 +1392,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, @@ -1453,6 +1523,16 @@

Method Details

"availableCpu": "A String", # The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU "availableMemory": "A String", # The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description. "binaryAuthorizationPolicy": "A String", # Optional. The binary authorization policy to be checked when deploying the Cloud Run service. + "directVpcEgress": "A String", # Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY. + "directVpcNetworkInterface": [ # Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported. + { # The Direct VPC network interface. This is mutually exclusive with VPC Connector. + "network": "A String", # Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network. + "subnetwork": "A String", # Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used. + "tags": [ # Optional. Network tags applied to this Cloud Function resource. + "A String", + ], + }, + ], "environmentVariables": { # Environment variables that shall be available during function execution. "a_key": "A String", }, diff --git a/docs/dyn/cloudfunctions_v2beta.projects.locations.html b/docs/dyn/cloudfunctions_v2beta.projects.locations.html index a8c81a7485..3cec56fc17 100644 --- a/docs/dyn/cloudfunctions_v2beta.projects.locations.html +++ b/docs/dyn/cloudfunctions_v2beta.projects.locations.html @@ -110,7 +110,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index fada2227da..f77ad4637c 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -190,7 +190,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -563,7 +563,7 @@ } } }, -"revision": "20250929", +"revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index 2e5c997898..cd59afcc5a 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -755,7 +755,7 @@ } } }, -"revision": "20250929", +"revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index bb6e13e083..c03e79db65 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -755,7 +755,7 @@ } } }, -"revision": "20250929", +"revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -947,6 +947,28 @@ "properties": {}, "type": "object" }, +"DirectVpcNetworkInterface": { +"description": "The Direct VPC network interface. This is mutually exclusive with VPC Connector.", +"id": "DirectVpcNetworkInterface", +"properties": { +"network": { +"description": "Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.", +"type": "string" +}, +"subnetwork": { +"description": "Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.", +"type": "string" +}, +"tags": { +"description": "Optional. Network tags applied to this Cloud Function resource.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "EventFilter": { "description": "Filters events based on exact matches on the CloudEvents attributes.", "id": "EventFilter", @@ -1876,6 +1898,27 @@ "description": "Optional. The binary authorization policy to be checked when deploying the Cloud Run service.", "type": "string" }, +"directVpcEgress": { +"description": "Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.", +"enum": [ +"DIRECT_VPC_EGRESS_UNSPECIFIED", +"VPC_EGRESS_PRIVATE_RANGES_ONLY", +"VPC_EGRESS_ALL_TRAFFIC" +], +"enumDescriptions": [ +"Unspecified.", +"Sends only traffic to internal addresses through the VPC network.", +"Sends all outbound traffic through the VPC network." +], +"type": "string" +}, +"directVpcNetworkInterface": { +"description": "Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.", +"items": { +"$ref": "DirectVpcNetworkInterface" +}, +"type": "array" +}, "environmentVariables": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json index bca7ddc4a8..6231ba891c 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -755,7 +755,7 @@ } } }, -"revision": "20250929", +"revision": "20251023", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -947,6 +947,28 @@ "properties": {}, "type": "object" }, +"DirectVpcNetworkInterface": { +"description": "The Direct VPC network interface. This is mutually exclusive with VPC Connector.", +"id": "DirectVpcNetworkInterface", +"properties": { +"network": { +"description": "Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.", +"type": "string" +}, +"subnetwork": { +"description": "Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.", +"type": "string" +}, +"tags": { +"description": "Optional. Network tags applied to this Cloud Function resource.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "EventFilter": { "description": "Filters events based on exact matches on the CloudEvents attributes.", "id": "EventFilter", @@ -1876,6 +1898,27 @@ "description": "Optional. The binary authorization policy to be checked when deploying the Cloud Run service.", "type": "string" }, +"directVpcEgress": { +"description": "Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.", +"enum": [ +"DIRECT_VPC_EGRESS_UNSPECIFIED", +"VPC_EGRESS_PRIVATE_RANGES_ONLY", +"VPC_EGRESS_ALL_TRAFFIC" +], +"enumDescriptions": [ +"Unspecified.", +"Sends only traffic to internal addresses through the VPC network.", +"Sends all outbound traffic through the VPC network." +], +"type": "string" +}, +"directVpcNetworkInterface": { +"description": "Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.", +"items": { +"$ref": "DirectVpcNetworkInterface" +}, +"type": "array" +}, "environmentVariables": { "additionalProperties": { "type": "string" From d55d33d3d82ed3045a20a6372368c06060aa7afe Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:11 +0000 Subject: [PATCH 18/70] feat(cloudidentity): update the api #### cloudidentity:v1beta1 The following keys were added: - resources.policies.methods.create (Total Keys: 8) - resources.policies.methods.delete (Total Keys: 11) - resources.policies.methods.patch (Total Keys: 12) --- docs/dyn/cloudidentity_v1.policies.html | 8 +- docs/dyn/cloudidentity_v1beta1.policies.html | 163 +++++++++++++++++- .../documents/cloudidentity.v1.json | 6 +- .../documents/cloudidentity.v1beta1.json | 77 ++++++++- 4 files changed, 240 insertions(+), 14 deletions(-) diff --git a/docs/dyn/cloudidentity_v1.policies.html b/docs/dyn/cloudidentity_v1.policies.html index 733476f1ba..42783c005c 100644 --- a/docs/dyn/cloudidentity_v1.policies.html +++ b/docs/dyn/cloudidentity_v1.policies.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

get(name, x__xgafv=None)

-

Get a Policy

+

Get a policy.

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

List Policies

+

List policies.

list_next()

Retrieves the next page of results.

@@ -94,7 +94,7 @@

Method Details

get(name, x__xgafv=None) - 
Get a Policy
+  
Get a policy.
 
 Args:
   name: string, Required. The name of the policy to retrieve. Format: "policies/{policy}". (required)
@@ -127,7 +127,7 @@ 
Method Details

 
 

     list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-  
List Policies
+  
List policies.
 
 Args:
   filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.
diff --git a/docs/dyn/cloudidentity_v1beta1.policies.html b/docs/dyn/cloudidentity_v1beta1.policies.html
index 0c0cd12178..a71d6a3d8c 100644
--- a/docs/dyn/cloudidentity_v1beta1.policies.html
+++ b/docs/dyn/cloudidentity_v1beta1.policies.html
@@ -77,24 +77,123 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  create(body=None, x__xgafv=None)

+
Create a policy.

+

+  delete(name, x__xgafv=None)

+
Delete a policy.

 

   get(name, x__xgafv=None)

-
Get a Policy

+
Get a policy.

 

   list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-
List Policies

+
List policies.

 

   list_next()

 
Retrieves the next page of results.

+

+  patch(name, body=None, x__xgafv=None)

+
Update a policy.

 
Method Details

 

     close()
   
Close httplib2 connections.

 

 
+

+    create(body=None, x__xgafv=None)
+  
Create a policy.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
+  "customer": "A String", # Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with "C" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
+  "name": "A String", # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
+  "policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
+    "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
+    "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
+    "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
+    "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set).
+  },
+  "setting": { # Setting # Required. The Setting configured by this Policy.
+    "type": "A String", # Required. Immutable. The type of the Setting. .
+    "value": { # Required. The value of the Setting.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "type": "A String", # Output only. The type of the policy.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    delete(name, x__xgafv=None)
+  
Delete a policy.
+
+Args:
+  name: string, Required. The name of the policy to retrieve. Format: "policies/{policy}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
 

     get(name, x__xgafv=None)
-  
Get a Policy
+  
Get a policy.
 
 Args:
   name: string, Required. The name of the policy to retrieve. Format: "policies/{policy}". (required)
@@ -127,7 +226,7 @@ 
Method Details

 
 

     list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-  
List Policies
+  
List policies.
 
 Args:
   filter: string, Optional. A CEL expression for filtering the results. Policies can be filtered by application with this expression: setting.type.matches('^settings/gmail\\..*$') Policies can be filtered by setting type with this expression: setting.type.matches('^.*\\.service_status$') A maximum of one of the above setting.type clauses can be used. Policies can be filtered by customer with this expression: customer == "customers/{customer}" Where `customer` is the `id` from the [Admin SDK `Customer` resource](https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). You may use `customers/my_customer` to specify your own organization. When no customer is mentioned it will be default to customers/my_customer. A maximum of one customer clause can be used. The above clauses can only be combined together in a single filter expression with the `&&` operator.
@@ -179,4 +278,60 @@ 
Method Details

         

 

 
+

+    patch(name, body=None, x__xgafv=None)
+  
Update a policy.
+
+Args:
+  name: string, Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A Policy resource binds an instance of a single Setting with the scope of a PolicyQuery. The Setting instance will be applied to all entities that satisfy the query.
+  "customer": "A String", # Immutable. Customer that the Policy belongs to. The value is in the format 'customers/{customerId}'. The `customerId` must begin with "C" To find your customer ID in Admin Console see https://support.google.com/a/answer/10070793.
+  "name": "A String", # Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.
+  "policyQuery": { # PolicyQuery # Required. The PolicyQuery the Setting applies to.
+    "group": "A String", # Immutable. The group that the query applies to. This field is only set if there is a single value for group that satisfies all clauses of the query. If no group applies, this will be the empty string.
+    "orgUnit": "A String", # Required. Immutable. Non-empty default. The OrgUnit the query applies to. This field is only set if there is a single value for org_unit that satisfies all clauses of the query.
+    "query": "A String", # Immutable. The CEL query that defines which entities the Policy applies to (ex. a User entity). For details about CEL see https://opensource.google.com/projects/cel. The OrgUnits the Policy applies to are represented by a clause like so: entity.org_units.exists(org_unit, org_unit.org_unit_id == orgUnitId('{orgUnitId}')) The Group the Policy applies to are represented by a clause like so: entity.groups.exists(group, group.group_id == groupId('{groupId}')) The Licenses the Policy applies to are represented by a clause like so: entity.licenses.exists(license, license in ['/product/{productId}/sku/{skuId}']) The above clauses can be present in any combination, and used in conjunction with the &&, || and ! operators. The org_unit and group fields below are helper fields that contain the corresponding value(s) as the query to make the query easier to use.
+    "sortOrder": 3.14, # Output only. The decimal sort order of this PolicyQuery. The value is relative to all other policies with the same setting type for the customer. (There are no duplicates within this set).
+  },
+  "setting": { # Setting # Required. The Setting configured by this Policy.
+    "type": "A String", # Required. Immutable. The type of the Setting. .
+    "value": { # Required. The value of the Setting.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "type": "A String", # Output only. The type of the policy.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
 
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
index 1b0fb08feb..1a1a4b13fd 100644
--- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json
@@ -2179,7 +2179,7 @@
 "policies": {
 "methods": {
 "get": {
-"description": "Get a Policy",
+"description": "Get a policy.",
 "flatPath": "v1/policies/{policiesId}",
 "httpMethod": "GET",
 "id": "cloudidentity.policies.get",
@@ -2205,7 +2205,7 @@
 ]
 },
 "list": {
-"description": "List Policies",
+"description": "List policies.",
 "flatPath": "v1/policies",
 "httpMethod": "GET",
 "id": "cloudidentity.policies.list",
@@ -2240,7 +2240,7 @@
 }
 }
 },
-"revision": "20250923",
+"revision": "20251021",
 "rootUrl": "https://cloudidentity.googleapis.com/",
 "schemas": {
 "AddIdpCredentialOperationMetadata": {
diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
index a38965c4fc..d1a96f0115 100644
--- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
@@ -2216,8 +2216,51 @@
 },
 "policies": {
 "methods": {
+"create": {
+"description": "Create a policy.",
+"flatPath": "v1beta1/policies",
+"httpMethod": "POST",
+"id": "cloudidentity.policies.create",
+"parameterOrder": [],
+"parameters": {},
+"path": "v1beta1/policies",
+"request": {
+"$ref": "Policy"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-identity.policies"
+]
+},
+"delete": {
+"description": "Delete a policy.",
+"flatPath": "v1beta1/policies/{policiesId}",
+"httpMethod": "DELETE",
+"id": "cloudidentity.policies.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the policy to retrieve. Format: \"policies/{policy}\".",
+"location": "path",
+"pattern": "^policies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-identity.policies"
+]
+},
 "get": {
-"description": "Get a Policy",
+"description": "Get a policy.",
 "flatPath": "v1beta1/policies/{policiesId}",
 "httpMethod": "GET",
 "id": "cloudidentity.policies.get",
@@ -2243,7 +2286,7 @@
 ]
 },
 "list": {
-"description": "List Policies",
+"description": "List policies.",
 "flatPath": "v1beta1/policies",
 "httpMethod": "GET",
 "id": "cloudidentity.policies.list",
@@ -2274,11 +2317,39 @@
 "https://www.googleapis.com/auth/cloud-identity.policies",
 "https://www.googleapis.com/auth/cloud-identity.policies.readonly"
 ]
+},
+"patch": {
+"description": "Update a policy.",
+"flatPath": "v1beta1/policies/{policiesId}",
+"httpMethod": "PATCH",
+"id": "cloudidentity.policies.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Identifier. The [resource name](https://cloud.google.com/apis/design/resource_names) of the Policy. Format: policies/{policy}.",
+"location": "path",
+"pattern": "^policies/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"request": {
+"$ref": "Policy"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-identity.policies"
+]
 }
 }
 }
 },
-"revision": "20250916",
+"revision": "20251027",
 "rootUrl": "https://cloudidentity.googleapis.com/",
 "schemas": {
 "AddIdpCredentialOperationMetadata": {

From aa4d8af269309a77657799795233644c83f41156 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:11 +0000
Subject: [PATCH 19/70] feat(cloudkms): update the api

#### cloudkms:v1

The following keys were deleted:
- resources.projects.methods.getAutokeyConfig (Total Keys: 11)
- resources.projects.methods.updateAutokeyConfig (Total Keys: 15)
---
 docs/dyn/cloudkms_v1.folders.html             |  6 +-
 docs/dyn/cloudkms_v1.projects.html            | 61 -------------
 docs/dyn/cloudkms_v1.projects.locations.html  |  2 +-
 .../documents/cloudkms.v1.json                | 85 +++++--------------
 4 files changed, 24 insertions(+), 130 deletions(-)

diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html
index 6581f5d8c2..468a2026ea 100644
--- a/docs/dyn/cloudkms_v1.folders.html
+++ b/docs/dyn/cloudkms_v1.folders.html
@@ -79,7 +79,7 @@ 
Instance Methods

 
Close httplib2 connections.

 

   getAutokeyConfig(name, x__xgafv=None)

-
Returns the AutokeyConfig for a folder or project.

+
Returns the AutokeyConfig for a folder.

 

   getKajPolicyConfig(name, x__xgafv=None)

 
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

@@ -97,10 +97,10 @@ 
Method Details

 
 

     getAutokeyConfig(name, x__xgafv=None)
-  
Returns the AutokeyConfig for a folder or project.
+  
Returns the AutokeyConfig for a folder.
 
 Args:
-  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html
index 192fcfb870..c41611a37a 100644
--- a/docs/dyn/cloudkms_v1.projects.html
+++ b/docs/dyn/cloudkms_v1.projects.html
@@ -82,9 +82,6 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

-

-  getAutokeyConfig(name, x__xgafv=None)

-
Returns the AutokeyConfig for a folder or project.

 

   getKajPolicyConfig(name, x__xgafv=None)

 
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

@@ -97,9 +94,6 @@ 
Instance Methods

 

   showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)

 
Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.

-

-  updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)

-
Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

 

   updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)

 
Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

@@ -109,28 +103,6 @@ 
Method Details

   
Close httplib2 connections.

 

 
-

-    getAutokeyConfig(name, x__xgafv=None)
-  
Returns the AutokeyConfig for a folder or project.
-
-Args:
-  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Cloud KMS Autokey configuration for a folder or project.
-  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
-  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
-  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
-  "state": "A String", # Output only. The state for the AutokeyConfig.
-}

-

-
 

     getKajPolicyConfig(name, x__xgafv=None)
   
Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
@@ -230,39 +202,6 @@ 
Method Details

 }

 

 
-

-    updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)
-  
Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
-
-Args:
-  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Cloud KMS Autokey configuration for a folder or project.
-  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
-  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
-  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
-  "state": "A String", # Output only. The state for the AutokeyConfig.
-}
-
-  updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Cloud KMS Autokey configuration for a folder or project.
-  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
-  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
-  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
-  "state": "A String", # Output only. The state for the AutokeyConfig.
-}

-

-
 

     updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)
   
Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
diff --git a/docs/dyn/cloudkms_v1.projects.locations.html b/docs/dyn/cloudkms_v1.projects.locations.html
index e3a2da1098..700f3d7c18 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.html
@@ -207,7 +207,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
index 5a2900cd41..e4b48930a7 100644
--- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
@@ -203,7 +203,7 @@
 "folders": {
 "methods": {
 "getAutokeyConfig": {
-"description": "Returns the AutokeyConfig for a folder or project.",
+"description": "Returns the AutokeyConfig for a folder.",
 "flatPath": "v1/folders/{foldersId}/autokeyConfig",
 "httpMethod": "GET",
 "id": "cloudkms.folders.getAutokeyConfig",
@@ -212,7 +212,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
+"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.",
 "location": "path",
 "pattern": "^folders/[^/]+/autokeyConfig$",
 "required": true,
@@ -393,32 +393,6 @@
 },
 "projects": {
 "methods": {
-"getAutokeyConfig": {
-"description": "Returns the AutokeyConfig for a folder or project.",
-"flatPath": "v1/projects/{projectsId}/autokeyConfig",
-"httpMethod": "GET",
-"id": "cloudkms.projects.getAutokeyConfig",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
-"location": "path",
-"pattern": "^projects/[^/]+/autokeyConfig$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "AutokeyConfig"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloudkms"
-]
-},
 "getKajPolicyConfig": {
 "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.",
 "flatPath": "v1/projects/{projectsId}/kajPolicyConfig",
@@ -523,41 +497,6 @@
 "https://www.googleapis.com/auth/cloudkms"
 ]
 },
-"updateAutokeyConfig": {
-"description": "Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.",
-"flatPath": "v1/projects/{projectsId}/autokeyConfig",
-"httpMethod": "PATCH",
-"id": "cloudkms.projects.updateAutokeyConfig",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.",
-"location": "path",
-"pattern": "^projects/[^/]+/autokeyConfig$",
-"required": true,
-"type": "string"
-},
-"updateMask": {
-"description": "Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.",
-"format": "google-fieldmask",
-"location": "query",
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"request": {
-"$ref": "AutokeyConfig"
-},
-"response": {
-"$ref": "AutokeyConfig"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/cloudkms"
-]
-},
 "updateKajPolicyConfig": {
 "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.",
 "flatPath": "v1/projects/{projectsId}/kajPolicyConfig",
@@ -688,7 +627,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2496,7 +2435,7 @@
 }
 }
 },
-"revision": "20250926",
+"revision": "20251023",
 "rootUrl": "https://cloudkms.googleapis.com/",
 "schemas": {
 "AsymmetricDecryptRequest": {
@@ -2965,7 +2904,9 @@
 "ML_KEM_768",
 "ML_KEM_1024",
 "KEM_XWING",
+"PQ_SIGN_ML_DSA_44",
 "PQ_SIGN_ML_DSA_65",
+"PQ_SIGN_ML_DSA_87",
 "PQ_SIGN_SLH_DSA_SHA2_128S",
 "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256"
 ],
@@ -3009,7 +2950,9 @@
 "ML-KEM-768 (FIPS 203)",
 "ML-KEM-1024 (FIPS 203)",
 "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.",
 "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests."
 ],
@@ -3183,7 +3126,9 @@
 "ML_KEM_768",
 "ML_KEM_1024",
 "KEM_XWING",
+"PQ_SIGN_ML_DSA_44",
 "PQ_SIGN_ML_DSA_65",
+"PQ_SIGN_ML_DSA_87",
 "PQ_SIGN_SLH_DSA_SHA2_128S",
 "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256"
 ],
@@ -3227,7 +3172,9 @@
 "ML-KEM-768 (FIPS 203)",
 "ML-KEM-1024 (FIPS 203)",
 "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.",
 "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests."
 ],
@@ -3676,7 +3623,9 @@
 "ML_KEM_768",
 "ML_KEM_1024",
 "KEM_XWING",
+"PQ_SIGN_ML_DSA_44",
 "PQ_SIGN_ML_DSA_65",
+"PQ_SIGN_ML_DSA_87",
 "PQ_SIGN_SLH_DSA_SHA2_128S",
 "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256"
 ],
@@ -3720,7 +3669,9 @@
 "ML-KEM-768 (FIPS 203)",
 "ML-KEM-1024 (FIPS 203)",
 "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.",
 "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests."
 ],
@@ -4437,7 +4388,9 @@
 "ML_KEM_768",
 "ML_KEM_1024",
 "KEM_XWING",
+"PQ_SIGN_ML_DSA_44",
 "PQ_SIGN_ML_DSA_65",
+"PQ_SIGN_ML_DSA_87",
 "PQ_SIGN_SLH_DSA_SHA2_128S",
 "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256"
 ],
@@ -4481,7 +4434,9 @@
 "ML-KEM-768 (FIPS 203)",
 "ML-KEM-1024 (FIPS 203)",
 "X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.",
 "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.",
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.",
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests."
 ],

From 68574b08de677e92f6b4ef73c9aa8981480fd244 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:11 +0000
Subject: [PATCH 20/70] feat(cloudscheduler): update the api

#### cloudscheduler:v1

The following keys were added:
- resources.projects.resources.locations.methods.getCmekConfig (Total Keys: 11)
- resources.projects.resources.locations.methods.updateCmekConfig (Total Keys: 15)
- schemas.CmekConfig (Total Keys: 4)

#### cloudscheduler:v1beta1

The following keys were added:
- resources.projects.resources.locations.resources.operations.methods.cancel (Total Keys: 12)
- resources.projects.resources.locations.resources.operations.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.operations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.operations.methods.list (Total Keys: 20)
- schemas.CancelOperationRequest (Total Keys: 2)
- schemas.ListOperationsResponse (Total Keys: 7)
- schemas.Operation (Total Keys: 9)
---
 .../cloudscheduler_v1.projects.locations.html |  72 +++++-
 ...dscheduler_v1.projects.locations.jobs.html |  74 +++---
 ...dscheduler_v1beta1.projects.locations.html |   7 +-
 ...duler_v1beta1.projects.locations.jobs.html |  74 +++---
 ...v1beta1.projects.locations.operations.html | 239 ++++++++++++++++++
 .../documents/cloudscheduler.v1.json          |  88 ++++++-
 .../documents/cloudscheduler.v1beta1.json     | 208 ++++++++++++++-
 7 files changed, 672 insertions(+), 90 deletions(-)
 create mode 100644 docs/dyn/cloudscheduler_v1beta1.projects.locations.operations.html

diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.html b/docs/dyn/cloudscheduler_v1.projects.locations.html
index fb02a9b98e..2fca1eace6 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.html
@@ -90,12 +90,18 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Gets information about a location.

+

+  getCmekConfig(name, x__xgafv=None)

+
Gets the Scheduler config in the project/region.

 

   list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists information about the supported locations for this service.

 

   list_next()

 
Retrieves the next page of results.

+

+  updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)

+
Initializes or Updates the a scheduler config.

 
Method Details

 

     close()
@@ -129,13 +135,33 @@ 
Method Details

 }

 

 
+

+    getCmekConfig(name, x__xgafv=None)
+  
Gets the Scheduler config in the project/region.
+
+Args:
+  name: string, Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Describes the project/location configuration of Cloud Scheduler Resources.
+  "kmsKeyName": "A String", # Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption.
+  "name": "A String", # Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
+}

+

+
 

     list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
   
Lists information about the supported locations for this service.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
@@ -179,4 +205,48 @@ 
Method Details

         

 

 
+

+    updateCmekConfig(name, body=None, updateMask=None, x__xgafv=None)
+  
Initializes or Updates the a scheduler config.
+
+Args:
+  name: string, Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Describes the project/location configuration of Cloud Scheduler Resources.
+  "kmsKeyName": "A String", # Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption.
+  "name": "A String", # Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
+}
+
+  updateMask: string, Optional. List of fields to be updated in this request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
 
\ No newline at end of file
diff --git a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
index 11b44c171e..ecd10475ed 100644
--- a/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1.projects.locations.jobs.html
@@ -153,7 +153,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -161,15 +161,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -227,7 +227,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -235,15 +235,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -326,7 +326,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -334,15 +334,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -411,7 +411,7 @@ 
Method Details

         "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
       },
       "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-      "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+      "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
       "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
         "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
           "a_key": "A String",
@@ -419,15 +419,15 @@ 
Method Details

         "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
         "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
       },
-      "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+      "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
         "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-        "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+        "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
         "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
         "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
         "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
       },
       "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-      "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+      "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
       "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
       "state": "A String", # Output only. State of the job.
       "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -466,7 +466,7 @@ 
Method Details

   
Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.
 
 Args:
-  name: string, Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. (required)
+  name: string, Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -504,7 +504,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -512,15 +512,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -579,7 +579,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -587,15 +587,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -666,7 +666,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -674,15 +674,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -753,7 +753,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -761,15 +761,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -840,7 +840,7 @@ 
Method Details

     "uri": "A String", # Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding.
   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -848,15 +848,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
index d325b844e2..d645fadd62 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.html
@@ -79,6 +79,11 @@ 
Instance Methods

 

 
Returns the jobs Resource.

 
+

+  operations()
+

+
Returns the operations Resource.

+
 

   close()

 
Close httplib2 connections.

@@ -130,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
index 0ec3c9efe0..7472fb5423 100644
--- a/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.jobs.html
@@ -154,7 +154,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -162,15 +162,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -229,7 +229,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -237,15 +237,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -330,7 +330,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -338,15 +338,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -418,7 +418,7 @@ 
Method Details

       },
       "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
       "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-      "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+      "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
       "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
         "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
           "a_key": "A String",
@@ -426,15 +426,15 @@ 
Method Details

         "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
         "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
       },
-      "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+      "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
         "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-        "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+        "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
         "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
         "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
         "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
       },
       "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-      "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+      "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
       "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
       "state": "A String", # Output only. State of the job.
       "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -473,7 +473,7 @@ 
Method Details

   
Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.
 
 Args:
-  name: string, Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. (required)
+  name: string, Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -512,7 +512,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -520,15 +520,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -588,7 +588,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -596,15 +596,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -676,7 +676,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -684,15 +684,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -764,7 +764,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -772,15 +772,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
@@ -853,7 +853,7 @@ 
Method Details

   },
   "lastAttemptTime": "A String", # Output only. The time the last job attempt started.
   "legacyAppEngineCron": True or False, # Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
-  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
+  "name": "A String", # Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
   "pubsubTarget": { # Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. # Pub/Sub target.
     "attributes": { # Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
       "a_key": "A String",
@@ -861,15 +861,15 @@ 
Method Details

     "data": "A String", # The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.
     "topicName": "A String", # Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.
   },
-  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
+  "retryConfig": { # Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. # Settings that determine the retry behavior.
     "maxBackoffDuration": "A String", # The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour.
-    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
+    "maxDoublings": 42, # The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.
     "maxRetryDuration": "A String", # The time limit for retrying a failed job, measured from the time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. However, if retry_count is also 0, a job attempt won't be retried if it fails.
     "minBackoffDuration": "A String", # The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds.
     "retryCount": 42, # The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0 (and if max_retry_duration is also 0), a job attempt won't be retried if it fails. Instead, Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 doesn't prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number, Cloud Scheduler will retry the failed job, using exponential backoff, for retry_count times until the job succeeds or the number of retries is exhausted. Note that the next scheduled execution time might be skipped if the retries continue through that time. Values greater than 5 and negative values are not allowed.
   },
   "satisfiesPzs": True or False, # Output only. Whether or not this Job satisfies the requirements of physical zone separation
-  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
+  "schedule": "A String", # Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.
   "scheduleTime": "A String", # Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule.
   "state": "A String", # Output only. State of the job.
   "status": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The response from the target for the last attempted execution.
diff --git a/docs/dyn/cloudscheduler_v1beta1.projects.locations.operations.html b/docs/dyn/cloudscheduler_v1beta1.projects.locations.operations.html
new file mode 100644
index 0000000000..2f0e9703b9
--- /dev/null
+++ b/docs/dyn/cloudscheduler_v1beta1.projects.locations.operations.html
@@ -0,0 +1,239 @@
+
+
+
+
Cloud Scheduler API . projects . locations . operations

+
Instance Methods

+

+  cancel(name, body=None, x__xgafv=None)

+
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.

+

+  close()

+
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
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`.

+

+  get(name, x__xgafv=None)

+
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.

+

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+  list_next()

+
Retrieves the next page of results.

+
Method Details

+

+    cancel(name, body=None, x__xgafv=None)
+  
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for Operations.CancelOperation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(name, x__xgafv=None)
+  
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
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.
+
+Args:
+  name: string, The name of the operation resource. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # This resource represents a long-running operation that is the result of a network API call.
+      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    },
+  ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json
index eb07eb58cb..122fa505bc 100644
--- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json
@@ -134,6 +134,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getCmekConfig": {
+"description": "Gets the Scheduler config in the project/region.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig",
+"httpMethod": "GET",
+"id": "cloudscheduler.projects.locations.getCmekConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The config name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "CmekConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "list": {
 "description": "Lists information about the supported locations for this service.",
 "flatPath": "v1/projects/{projectsId}/locations",
@@ -144,7 +169,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -180,6 +205,40 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"updateCmekConfig": {
+"description": "Initializes or Updates the a scheduler config.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig",
+"httpMethod": "PATCH",
+"id": "cloudscheduler.projects.locations.updateCmekConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. List of fields to be updated in this request.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "CmekConfig"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -309,7 +368,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
+"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
 "required": true,
@@ -552,7 +611,7 @@
 }
 }
 },
-"revision": "20250925",
+"revision": "20251022",
 "rootUrl": "https://cloudscheduler.googleapis.com/",
 "schemas": {
 "AppEngineHttpTarget": {
@@ -635,6 +694,21 @@
 "properties": {},
 "type": "object"
 },
+"CmekConfig": {
+"description": "Describes the project/location configuration of Cloud Scheduler Resources.",
+"id": "CmekConfig",
+"properties": {
+"kmsKeyName": {
+"description": "Optional. Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt Jobs in the region. Setting this as blank will turn off CMEK encryption.",
+"type": "string"
+},
+"name": {
+"description": "Identifier. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Empty": {
 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
 "id": "Empty",
@@ -724,7 +798,7 @@
 "type": "string"
 },
 "name": {
-"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
+"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
 "type": "string"
 },
 "pubsubTarget": {
@@ -741,7 +815,7 @@
 "type": "boolean"
 },
 "schedule": {
-"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.",
+"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.",
 "type": "string"
 },
 "scheduleTime": {
@@ -1059,7 +1133,7 @@
 "type": "object"
 },
 "RetryConfig": {
-"description": "Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.",
+"description": "Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.",
 "id": "RetryConfig",
 "properties": {
 "maxBackoffDuration": {
@@ -1068,7 +1142,7 @@
 "type": "string"
 },
 "maxDoublings": {
-"description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.",
+"description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.",
 "format": "int32",
 "type": "integer"
 },
diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json
index be91f4d781..1fc339ddfe 100644
--- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -324,7 +324,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
+"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/jobs/[^/]+$",
 "required": true,
@@ -433,13 +433,141 @@
 ]
 }
 }
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "cloudscheduler.projects.locations.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:cancel",
+"request": {
+"$ref": "CancelOperationRequest"
+},
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "cloudscheduler.projects.locations.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "cloudscheduler.projects.locations.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations",
+"httpMethod": "GET",
+"id": "cloudscheduler.projects.locations.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1beta1/{+name}/operations",
+"response": {
+"$ref": "ListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
 }
 }
 }
 }
 }
 },
-"revision": "20250917",
+"revision": "20251022",
 "rootUrl": "https://cloudscheduler.googleapis.com/",
 "schemas": {
 "AppEngineHttpTarget": {
@@ -516,6 +644,12 @@
 },
 "type": "object"
 },
+"CancelOperationRequest": {
+"description": "The request message for Operations.CancelOperation.",
+"id": "CancelOperationRequest",
+"properties": {},
+"type": "object"
+},
 "Empty": {
 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
 "id": "Empty",
@@ -609,7 +743,7 @@
 "type": "boolean"
 },
 "name": {
-"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
+"description": "Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling [locations.list](/scheduler/docs/reference/rest/v1beta1/projects.locations/list). For more information, see [Cloud Scheduler locations](/scheduler/docs/locations). * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.",
 "type": "string"
 },
 "pubsubTarget": {
@@ -626,7 +760,7 @@
 "type": "boolean"
 },
 "schedule": {
-"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.",
+"description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure.",
 "type": "string"
 },
 "scheduleTime": {
@@ -708,6 +842,31 @@
 },
 "type": "object"
 },
+"ListOperationsResponse": {
+"description": "The response message for Operations.ListOperations.",
+"id": "ListOperationsResponse",
+"properties": {
+"nextPageToken": {
+"description": "The standard List next-page token.",
+"type": "string"
+},
+"operations": {
+"description": "A list of operations that matches the specified filter in the request.",
+"items": {
+"$ref": "Operation"
+},
+"type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Location": {
 "description": "A resource that represents a Google Cloud location.",
 "id": "Location",
@@ -772,6 +931,41 @@
 },
 "type": "object"
 },
+"Operation": {
+"description": "This resource represents a long-running operation that is the result of a network API call.",
+"id": "Operation",
+"properties": {
+"done": {
+"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
+"type": "boolean"
+},
+"error": {
+"$ref": "Status",
+"description": "The error result of the operation in case of failure or cancellation."
+},
+"metadata": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+"type": "object"
+},
+"name": {
+"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
+"type": "string"
+},
+"response": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
+"type": "object"
+}
+},
+"type": "object"
+},
 "OperationMetadata": {
 "description": "Represents the metadata of the long-running operation.",
 "id": "OperationMetadata",
@@ -884,7 +1078,7 @@
 "type": "object"
 },
 "RetryConfig": {
-"description": "Settings that determine the retry behavior. For more information, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.",
+"description": "Settings that determine the retry behavior. For more information, see [Retry jobs](/scheduler/docs/configuring/retry-jobs). By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig.",
 "id": "RetryConfig",
 "properties": {
 "maxBackoffDuration": {
@@ -893,7 +1087,7 @@
 "type": "string"
 },
 "maxDoublings": {
-"description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](https://cloud.google.com/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.",
+"description": "The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For examples, see [Retry jobs](/scheduler/docs/configuring/retry-jobs#max-doublings). The default value of this field is 5.",
 "format": "int32",
 "type": "integer"
 },

From 385aad3a9db1c1e964dfabe2aec63510e495f929 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:11 +0000
Subject: [PATCH 21/70] feat(compute): update the api

#### compute:alpha

The following keys were deleted:
- resources.globalVmExtensionPolicies.methods.delete.parameters.rolloutInput.conflictBehavior (Total Keys: 2)
- resources.globalVmExtensionPolicies.methods.delete.parameters.rolloutInput.name (Total Keys: 2)
- resources.globalVmExtensionPolicies.methods.delete.parameters.rolloutInput.predefinedRolloutPlan (Total Keys: 2)
- resources.globalVmExtensionPolicies.methods.delete.parameters.rolloutInput.retryUuid (Total Keys: 2)

The following keys were added:
- resources.globalVmExtensionPolicies.methods.delete.request.$ref (Total Keys: 1)
- resources.haControllers.methods.aggregatedList (Total Keys: 29)
- resources.rolloutPlans.methods.delete (Total Keys: 17)
- resources.rolloutPlans.methods.get (Total Keys: 15)
- resources.rolloutPlans.methods.insert (Total Keys: 14)
- resources.rolloutPlans.methods.list (Total Keys: 24)
- resources.rollouts.methods.cancel (Total Keys: 19)
- resources.rollouts.methods.delete (Total Keys: 17)
- resources.rollouts.methods.get (Total Keys: 15)
- resources.rollouts.methods.list (Total Keys: 24)
- resources.subnetworks.methods.aggregatedList.parameters.views (Total Keys: 3)
- schemas.HaControllersAggregatedList (Total Keys: 18)
- schemas.HaControllersFailoverRequest.properties.failoverToZone (Total Keys: 2)
- schemas.HaControllersFailoverRequest.properties.primaryZone.deprecated (Total Keys: 1)
- schemas.HaControllersScopedList (Total Keys: 11)
- schemas.Instance.properties.identity.deprecated (Total Keys: 1)
- schemas.Instance.properties.identityCertificate.deprecated (Total Keys: 1)
- schemas.Instance.properties.workloadIdentityConfig.$ref (Total Keys: 1)
- schemas.InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection.properties.disks (Total Keys: 2)
- schemas.InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection.properties.minCpuPlatform.type (Total Keys: 1)
- schemas.InstanceProperties.properties.identity.deprecated (Total Keys: 1)
- schemas.InstanceProperties.properties.identityCertificate.deprecated (Total Keys: 1)
- schemas.InstanceProperties.properties.workloadIdentityConfig.$ref (Total Keys: 1)
- schemas.ManagedInstanceInstanceFlexibilityOverride.properties.disks (Total Keys: 2)
- schemas.ManagedInstanceInstanceFlexibilityOverride.properties.minCpuPlatform.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowAddressCreation.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowMultiNicInSameSubnetwork.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowMulticast.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowSubnetworkCreation.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.multicast.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.predefinedNetworkInternalIpv6Range.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.predefinedSubnetworkRanges (Total Keys: 2)
- schemas.NetworkProfileNetworkFeaturesPredefinedSubnetworkRange (Total Keys: 4)
- schemas.ResourcePolicyGroupPlacementPolicy.properties.acceleratorTopologyMode.type (Total Keys: 1)
- schemas.Rollout (Total Keys: 145)
- schemas.WorkloadIdentityConfig (Total Keys: 4)

The following keys were changed:
- resources.globalVmExtensionPolicies.methods.delete (Total Keys: 3)

#### compute:beta

The following keys were added:
- resources.firewallPolicies.methods.listAssociations.parameters.includeInheritedPolicies (Total Keys: 2)
- resources.globalVmExtensionPolicies.methods.aggregatedList (Total Keys: 29)
- resources.globalVmExtensionPolicies.methods.get (Total Keys: 15)
- resources.instanceGroupManagers.methods.getAvailableAcceleratorTopologies (Total Keys: 17)
- resources.reservationSubBlocks.methods.get.parameters.view (Total Keys: 2)
- resources.subnetworks.methods.aggregatedList.parameters.views (Total Keys: 3)
- resources.zoneVmExtensionPolicies.methods.delete (Total Keys: 20)
- resources.zoneVmExtensionPolicies.methods.get (Total Keys: 19)
- resources.zoneVmExtensionPolicies.methods.insert (Total Keys: 18)
- resources.zoneVmExtensionPolicies.methods.list (Total Keys: 28)
- resources.zoneVmExtensionPolicies.methods.update (Total Keys: 21)
- schemas.AcceleratorTopologiesInfo (Total Keys: 14)
- schemas.BackendBucket.properties.region.type (Total Keys: 1)
- schemas.BackendServiceTlsSettings.properties.identity.type (Total Keys: 1)
- schemas.CompositeHealthCheckAggregatedList.properties.unreachables (Total Keys: 2)
- schemas.GlobalVmExtensionPolicy (Total Keys: 51)
- schemas.HealthSourceAggregatedList.properties.unreachables (Total Keys: 2)
- schemas.InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse (Total Keys: 8)
- schemas.InterconnectAttachment.properties.l2Forwarding.$ref (Total Keys: 1)
- schemas.InterconnectAttachmentL2Forwarding (Total Keys: 23)
- schemas.InterconnectLocationRegionInfo.properties.l2ForwardingEnabled.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowMulticast.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.multicast.type (Total Keys: 1)
- schemas.ReservationSubBlock.properties.acceleratorTopologiesInfo.$ref (Total Keys: 1)
- schemas.ResourcePolicyGroupPlacementPolicy.properties.acceleratorTopologyMode.type (Total Keys: 1)
- schemas.ShieldedInstanceIdentity.properties.eccP256EncryptionKey.$ref (Total Keys: 1)
- schemas.ShieldedInstanceIdentity.properties.eccP256SigningKey.$ref (Total Keys: 1)
- schemas.VmExtensionPoliciesScopedList (Total Keys: 11)
- schemas.VmExtensionPolicy (Total Keys: 69)

#### compute:v1

The following keys were added:
- resources.firewalls.methods.testIamPermissions (Total Keys: 16)
- resources.reservationSubBlocks.methods.get.parameters.view (Total Keys: 2)
- resources.subnetworks.methods.aggregatedList.parameters.views (Total Keys: 3)
- schemas.AcceleratorTopologiesInfo (Total Keys: 14)
- schemas.FutureReservation.properties.reservationMode.type (Total Keys: 1)
- schemas.GRPCTLSHealthCheck (Total Keys: 6)
- schemas.HealthCheck.properties.grpcTlsHealthCheck.$ref (Total Keys: 1)
- schemas.Interconnect.properties.params.$ref (Total Keys: 1)
- schemas.InterconnectAttachment.properties.l2Forwarding.$ref (Total Keys: 1)
- schemas.InterconnectAttachment.properties.params.$ref (Total Keys: 1)
- schemas.InterconnectAttachmentL2Forwarding (Total Keys: 23)
- schemas.InterconnectAttachmentParams (Total Keys: 4)
- schemas.InterconnectLocationRegionInfo.properties.l2ForwardingEnabled.type (Total Keys: 1)
- schemas.InterconnectParams (Total Keys: 4)
- schemas.NetworkInterface.properties.igmpQuery.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.allowMulticast.type (Total Keys: 1)
- schemas.NetworkProfileNetworkFeatures.properties.multicast.type (Total Keys: 1)
- schemas.Reservation.properties.protectionTier.type (Total Keys: 1)
- schemas.ReservationSubBlock.properties.acceleratorTopologiesInfo.$ref (Total Keys: 1)
- schemas.ShieldedInstanceIdentity.properties.eccP256EncryptionKey.$ref (Total Keys: 1)
- schemas.ShieldedInstanceIdentity.properties.eccP256SigningKey.$ref (Total Keys: 1)
---
 docs/dyn/compute_alpha.acceleratorTypes.html  |    2 +-
 docs/dyn/compute_alpha.addresses.html         |    2 +-
 docs/dyn/compute_alpha.advice.html            |    3 +-
 docs/dyn/compute_alpha.autoscalers.html       |    2 +-
 docs/dyn/compute_alpha.backendBuckets.html    |   14 +-
 docs/dyn/compute_alpha.backendServices.html   |  177 +-
 docs/dyn/compute_alpha.diskTypes.html         |    2 +-
 docs/dyn/compute_alpha.disks.html             |    2 +-
 docs/dyn/compute_alpha.forwardingRules.html   |    2 +-
 .../dyn/compute_alpha.futureReservations.html |    2 +-
 ...mpute_alpha.globalVmExtensionPolicies.html |   52 +-
 docs/dyn/compute_alpha.haControllers.html     |  632 ++
 docs/dyn/compute_alpha.html                   |   10 +
 .../compute_alpha.instanceGroupManagers.html  | 6470 ++++++++++++++++-
 docs/dyn/compute_alpha.instanceTemplates.html |   16 +
 docs/dyn/compute_alpha.instances.html         |   24 +
 ...compute_alpha.interconnectAttachments.html |   10 +
 .../dyn/compute_alpha.interconnectGroups.html |    8 +-
 docs/dyn/compute_alpha.machineImages.html     |   12 +
 ...compute_alpha.networkFirewallPolicies.html |    2 +-
 docs/dyn/compute_alpha.networkProfiles.html   |   24 +
 docs/dyn/compute_alpha.projects.html          |    9 +-
 .../compute_alpha.regionBackendBuckets.html   |   10 +-
 .../compute_alpha.regionBackendServices.html  |  150 +-
 docs/dyn/compute_alpha.regionCommitments.html |    2 +-
 ...ute_alpha.regionCompositeHealthChecks.html |    2 +-
 ...alpha.regionHealthAggregationPolicies.html |    2 +-
 ...mpute_alpha.regionHealthCheckServices.html |    2 +-
 ...ute_alpha.regionInstanceGroupManagers.html | 5468 +++++++++++++-
 ...compute_alpha.regionInstanceTemplates.html |   12 +
 docs/dyn/compute_alpha.regionInstances.html   |    4 +
 docs/dyn/compute_alpha.reservations.html      |    2 +-
 docs/dyn/compute_alpha.resourcePolicies.html  |   10 +
 docs/dyn/compute_alpha.rolloutPlans.html      | 1107 +++
 docs/dyn/compute_alpha.rollouts.html          |  982 +++
 docs/dyn/compute_alpha.routers.html           |   12 +-
 docs/dyn/compute_alpha.routes.html            |   12 +-
 docs/dyn/compute_alpha.subnetworks.html       |   12 +-
 .../compute_alpha.zoneQueuedResources.html    |   16 +
 docs/dyn/compute_beta.acceleratorTypes.html   |    2 +-
 docs/dyn/compute_beta.addresses.html          |    2 +-
 docs/dyn/compute_beta.autoscalers.html        |    2 +-
 docs/dyn/compute_beta.backendBuckets.html     |   42 +-
 docs/dyn/compute_beta.backendServices.html    |  324 +-
 docs/dyn/compute_beta.diskTypes.html          |    2 +-
 docs/dyn/compute_beta.disks.html              |    2 +-
 docs/dyn/compute_beta.firewallPolicies.html   |    7 +-
 docs/dyn/compute_beta.forwardingRules.html    |    2 +-
 docs/dyn/compute_beta.futureReservations.html |    2 +-
 ...ompute_beta.globalVmExtensionPolicies.html |  464 ++
 docs/dyn/compute_beta.html                    |   10 +
 .../compute_beta.instanceGroupManagers.html   |   69 +
 docs/dyn/compute_beta.instances.html          |   10 +
 .../compute_beta.interconnectAttachments.html |  340 +
 docs/dyn/compute_beta.interconnectGroups.html |    8 +-
 .../compute_beta.interconnectLocations.html   |    4 +
 .../compute_beta.networkFirewallPolicies.html |    2 +-
 docs/dyn/compute_beta.networkProfiles.html    |    4 +
 docs/dyn/compute_beta.projects.html           |    9 +-
 .../compute_beta.regionBackendBuckets.html    |   30 +-
 .../compute_beta.regionBackendServices.html   |  276 +-
 docs/dyn/compute_beta.regionCommitments.html  |    2 +-
 ...pute_beta.regionCompositeHealthChecks.html |    5 +-
 ..._beta.regionHealthAggregationPolicies.html |    2 +-
 .../dyn/compute_beta.regionHealthSources.html |    3 +
 ...pute_beta.regionInstanceGroupManagers.html |   30 +
 .../compute_beta.reservationSubBlocks.html    |   35 +-
 docs/dyn/compute_beta.reservations.html       |    2 +-
 docs/dyn/compute_beta.resourcePolicies.html   |   10 +
 docs/dyn/compute_beta.routers.html            |   12 +-
 docs/dyn/compute_beta.routes.html             |   12 +-
 docs/dyn/compute_beta.subnetworks.html        |   12 +-
 .../compute_beta.zoneVmExtensionPolicies.html | 1365 ++++
 docs/dyn/compute_v1.acceleratorTypes.html     |    2 +-
 docs/dyn/compute_v1.addresses.html            |    2 +-
 docs/dyn/compute_v1.autoscalers.html          |    2 +-
 docs/dyn/compute_v1.backendBuckets.html       |   10 +-
 docs/dyn/compute_v1.backendServices.html      |   58 +-
 docs/dyn/compute_v1.diskTypes.html            |    2 +-
 docs/dyn/compute_v1.disks.html                |    2 +-
 docs/dyn/compute_v1.firewalls.html            |   36 +
 docs/dyn/compute_v1.forwardingRules.html      |    2 +-
 docs/dyn/compute_v1.futureReservations.html   |   12 +-
 docs/dyn/compute_v1.healthChecks.html         |  216 +
 docs/dyn/compute_v1.instanceTemplates.html    |    8 +
 docs/dyn/compute_v1.instances.html            |   26 +
 .../compute_v1.interconnectAttachments.html   |  435 ++
 docs/dyn/compute_v1.interconnectGroups.html   |    8 +-
 .../dyn/compute_v1.interconnectLocations.html |    4 +
 docs/dyn/compute_v1.interconnects.html        |   76 +
 docs/dyn/compute_v1.machineImages.html        |   12 +
 .../compute_v1.networkFirewallPolicies.html   |    2 +-
 docs/dyn/compute_v1.networkProfiles.html      |    4 +
 docs/dyn/compute_v1.projects.html             |    9 +-
 .../dyn/compute_v1.regionBackendServices.html |   48 +-
 docs/dyn/compute_v1.regionCommitments.html    |   17 +-
 docs/dyn/compute_v1.regionHealthChecks.html   |  180 +
 .../compute_v1.regionInstanceTemplates.html   |    6 +
 docs/dyn/compute_v1.regionInstances.html      |    2 +
 docs/dyn/compute_v1.reservationSubBlocks.html |   35 +-
 docs/dyn/compute_v1.reservations.html         |   17 +-
 docs/dyn/compute_v1.routers.html              |   12 +-
 docs/dyn/compute_v1.routes.html               |   12 +-
 docs/dyn/compute_v1.subnetworks.html          |   12 +-
 .../documents/compute.alpha.json              | 2023 +++++-
 .../documents/compute.beta.json               | 2030 +++++-
 .../discovery_cache/documents/compute.v1.json |  417 +-
 107 files changed, 23198 insertions(+), 926 deletions(-)
 create mode 100644 docs/dyn/compute_alpha.rolloutPlans.html
 create mode 100644 docs/dyn/compute_alpha.rollouts.html
 create mode 100644 docs/dyn/compute_beta.globalVmExtensionPolicies.html
 create mode 100644 docs/dyn/compute_beta.zoneVmExtensionPolicies.html

diff --git a/docs/dyn/compute_alpha.acceleratorTypes.html b/docs/dyn/compute_alpha.acceleratorTypes.html
index 9d806867e8..a14334cc06 100644
--- a/docs/dyn/compute_alpha.acceleratorTypes.html
+++ b/docs/dyn/compute_alpha.acceleratorTypes.html
@@ -97,7 +97,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of accelerator types.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html
index b64b9d9cfa..38f0602737 100644
--- a/docs/dyn/compute_alpha.addresses.html
+++ b/docs/dyn/compute_alpha.addresses.html
@@ -112,7 +112,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of addresses.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html
index 9eebc43069..1bfac9ef7d 100644
--- a/docs/dyn/compute_alpha.advice.html
+++ b/docs/dyn/compute_alpha.advice.html
@@ -273,7 +273,8 @@ 
Method Details

         "obtainability": 3.14, # The obtainability score indicates the likelihood of successfully
             # obtaining (provisioning) the requested number of VMs.
             # The score range is 0.0 through 1.0. Higher is better.
-        "uptimeScore": 3.14, # The uptime score indicates the availability of your Spot VMs. For more
+        "uptimeScore": 3.14, # The uptime score indicates the likelihood that your Spot VMs will
+            # continue to run without preemption within the next few hours. For more
             # information about the preemption process, see Preemption
             # of Spot VMs.
             # The score range is 0.0 through 1.0. Higher is better.
diff --git a/docs/dyn/compute_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html
index 9eab328164..102d554a4b 100644
--- a/docs/dyn/compute_alpha.autoscalers.html
+++ b/docs/dyn/compute_alpha.autoscalers.html
@@ -112,7 +112,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of autoscalers.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html
index 5b4fa32f04..b5de3afe5f 100644
--- a/docs/dyn/compute_alpha.backendBuckets.html
+++ b/docs/dyn/compute_alpha.backendBuckets.html
@@ -641,7 +641,7 @@ 
Method Details

                 # negative caching when a policy exists.
               { # Specify CDN TTLs for response error codes.
                 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                     # specified as values, and you cannot specify a status code more than
                     # once.
                 "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1496,7 +1496,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2068,7 +2068,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2636,7 +2636,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2964,7 +2964,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -3234,7 +3234,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -4908,7 +4908,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html
index 03c7f0c83f..b338bd0d33 100644
--- a/docs/dyn/compute_alpha.backendServices.html
+++ b/docs/dyn/compute_alpha.backendServices.html
@@ -440,7 +440,7 @@ 
Method Details

   
Retrieves the list of all BackendService resources, regional and global,
 available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -615,7 +615,8 @@ 
Method Details

                   "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                       # balancing mode. The valid range is [0.0, 1.0].
                   "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                      # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                      # long and match the regular expression
+                      # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                       # first character must be a lowercase letter, and all following
                       # characters must be a dash, period, underscore, lowercase letter, or
                       # digit, except the last character, which cannot be a dash, period, or
@@ -811,7 +812,7 @@ 
Method Details

                 # negative caching when a policy exists.
               { # Specify CDN TTLs for response error codes.
                 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                     # specified as values, and you cannot specify a status code more than
                     # once.
                 "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1003,7 +1004,8 @@ 
Method Details

                 # locality_lb_policy.
               "dryRun": True or False, # If true, the metric data is not used for load balancing.
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -2208,25 +2210,24 @@ 
Method Details

                 # networksecurity.googleapis.com namespace. Can be used in authenticating
                 # TLS connections to the backend, as specified by the authenticationMode
                 # field. Can only be specified if authenticationMode is not NONE.
-            "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+            "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
                 #
                 #
                 # Use this property to configure the load balancer back-end to use
                 # certificates and roots of trust provisioned by the Managed Workload
                 # Identity system.
                 #
-                #  The `managedIdentity` property is the
+                #  The `identity` property is the
                 # fully-specified SPIFFE ID to use in the SVID presented by the Load
                 # Balancer Workload.
                 #
                 #  The SPIFFE ID must be a resource starting with the
-                # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-                # followed by the path to the Managed Workload Identity.
+                # `trustDomain` property value, followed by the path to the Managed
+                # Workload Identity.
                 #
-                #  Supported
-                # SPIFFE ID format:
+                #  Supported SPIFFE ID format:
                 #
-                #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+                #    - //<trust_domain>/ns/<namespace>/sa/<subject>
                 #
                 #
                 # The Trust Domain within the Managed Identity must refer to a valid
@@ -2235,14 +2236,14 @@ 
Method Details

                 #
                 #  Restrictions:
                 #
-                #    - If you set the `managedIdentity` property, you cannot manually set
+                #    - If you set the `identity` property, you cannot manually set
                 #    the following fields:
                 #        - tlsSettings.sni
                 #       - tlsSettings.subjectAltNames
                 #       - tlsSettings.authenticationConfig
                 #
                 #
-                # When defining a `managedIdentity` for a RegionBackendServices, the
+                # When defining a `identity` for a RegionBackendServices, the
                 # corresponding Workload Identity Pool must have a ca_pool
                 # configured in the same region.
                 #
@@ -3020,7 +3021,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -3216,7 +3218,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -3408,7 +3410,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -4613,25 +4616,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -4640,14 +4642,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
@@ -5959,7 +5961,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -6155,7 +6158,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -6347,7 +6350,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -7552,25 +7556,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -7579,14 +7582,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
@@ -8074,7 +8077,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -8270,7 +8274,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -8462,7 +8466,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -9667,25 +9672,24 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
-        "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
             #
             #
             # Use this property to configure the load balancer back-end to use
             # certificates and roots of trust provisioned by the Managed Workload
             # Identity system.
             #
-            #  The `managedIdentity` property is the
+            #  The `identity` property is the
             # fully-specified SPIFFE ID to use in the SVID presented by the Load
             # Balancer Workload.
             #
             #  The SPIFFE ID must be a resource starting with the
-            # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-            # followed by the path to the Managed Workload Identity.
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
             #
-            #  Supported
-            # SPIFFE ID format:
+            #  Supported SPIFFE ID format:
             #
-            #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
             #
             #
             # The Trust Domain within the Managed Identity must refer to a valid
@@ -9694,14 +9698,14 @@ 
Method Details

             #
             #  Restrictions:
             #
-            #    - If you set the `managedIdentity` property, you cannot manually set
+            #    - If you set the `identity` property, you cannot manually set
             #    the following fields:
             #        - tlsSettings.sni
             #       - tlsSettings.subjectAltNames
             #       - tlsSettings.authenticationConfig
             #
             #
-            # When defining a `managedIdentity` for a RegionBackendServices, the
+            # When defining a `identity` for a RegionBackendServices, the
             # corresponding Workload Identity Pool must have a ca_pool
             # configured in the same region.
             #
@@ -9949,7 +9953,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -10145,7 +10150,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -10337,7 +10342,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -11542,25 +11548,24 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
-        "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
             #
             #
             # Use this property to configure the load balancer back-end to use
             # certificates and roots of trust provisioned by the Managed Workload
             # Identity system.
             #
-            #  The `managedIdentity` property is the
+            #  The `identity` property is the
             # fully-specified SPIFFE ID to use in the SVID presented by the Load
             # Balancer Workload.
             #
             #  The SPIFFE ID must be a resource starting with the
-            # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-            # followed by the path to the Managed Workload Identity.
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
             #
-            #  Supported
-            # SPIFFE ID format:
+            #  Supported SPIFFE ID format:
             #
-            #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
             #
             #
             # The Trust Domain within the Managed Identity must refer to a valid
@@ -11569,14 +11574,14 @@ 
Method Details

             #
             #  Restrictions:
             #
-            #    - If you set the `managedIdentity` property, you cannot manually set
+            #    - If you set the `identity` property, you cannot manually set
             #    the following fields:
             #        - tlsSettings.sni
             #       - tlsSettings.subjectAltNames
             #       - tlsSettings.authenticationConfig
             #
             #
-            # When defining a `managedIdentity` for a RegionBackendServices, the
+            # When defining a `identity` for a RegionBackendServices, the
             # corresponding Workload Identity Pool must have a ca_pool
             # configured in the same region.
             #
@@ -11767,7 +11772,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -11963,7 +11969,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -12155,7 +12161,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -13360,25 +13367,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -13387,14 +13393,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
@@ -15280,7 +15286,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -15476,7 +15483,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -15668,7 +15675,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -16873,25 +16881,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -16900,14 +16907,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
diff --git a/docs/dyn/compute_alpha.diskTypes.html b/docs/dyn/compute_alpha.diskTypes.html
index 22727e790f..5980cb3ae9 100644
--- a/docs/dyn/compute_alpha.diskTypes.html
+++ b/docs/dyn/compute_alpha.diskTypes.html
@@ -97,7 +97,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of disk types.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html
index 6e3421855e..d82fd072ae 100644
--- a/docs/dyn/compute_alpha.disks.html
+++ b/docs/dyn/compute_alpha.disks.html
@@ -448,7 +448,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of persistent disks.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html
index 4c7b9523fc..66baf8cf1b 100644
--- a/docs/dyn/compute_alpha.forwardingRules.html
+++ b/docs/dyn/compute_alpha.forwardingRules.html
@@ -115,7 +115,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of forwarding rules.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html
index fa0b1a3abb..3cdc828930 100644
--- a/docs/dyn/compute_alpha.futureReservations.html
+++ b/docs/dyn/compute_alpha.futureReservations.html
@@ -109,7 +109,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of future reservations.
 
-To prevent failure, recommendation is that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
index 3ecf989295..595a3cf39a 100644
--- a/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
+++ b/docs/dyn/compute_alpha.globalVmExtensionPolicies.html
@@ -84,7 +84,7 @@ 
Instance Methods

   close()

 
Close httplib2 connections.

 

-  delete(project, globalVmExtensionPolicy, requestId=None, rolloutInput_conflictBehavior=None, rolloutInput_name=None, rolloutInput_predefinedRolloutPlan=None, rolloutInput_retryUuid=None, x__xgafv=None)

+  delete(project, globalVmExtensionPolicy, body=None, requestId=None, x__xgafv=None)

 
Purge scoped resources (zonal policies) from a global VM extension

 

   get(project, globalVmExtensionPolicy, x__xgafv=None)

@@ -364,7 +364,7 @@ 
Method Details

 

 
 

-    delete(project, globalVmExtensionPolicy, requestId=None, rolloutInput_conflictBehavior=None, rolloutInput_name=None, rolloutInput_predefinedRolloutPlan=None, rolloutInput_retryUuid=None, x__xgafv=None)
+    delete(project, globalVmExtensionPolicy, body=None, requestId=None, x__xgafv=None)
   
Purge scoped resources (zonal policies) from a global VM extension
 policy, and then delete the global VM extension policy. Purge of the scoped
 resources is a pre-condition of the global VM extension policy deletion.
@@ -375,6 +375,31 @@ 
Method Details

 Args:
   project: string, Project ID for this request. (required)
   globalVmExtensionPolicy: string, Name of the global VM extension policy to purge scoped resources for. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "conflictBehavior": "A String", # Optional. [Optional] Specifies the behavior of the Rollout if a conflict is
+      # detected in a project during a Rollout. It can be one of the following
+      # values:
+      # 1) empty : don't overwrite the local value if conflict happens. This is
+      # the default behavior.
+      # 2) "overwrite" : Overwrite the local value with the rollout value.
+      # The concept of "conflict" applies to:
+      # 1) Insert action. If the zonal policy already exists when Insert
+      # happens, it's a conflict.
+      # 2) Update action. If the zonal policy was updated out of band by a
+      # zonal API, it's a conflict.
+  "name": "A String", # Optional. The name of the rollout plan.
+      # Ex.
+      # projects//locations/global/rolloutPlans/.
+  "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan.
+  "retryUuid": "A String", # Optional. The UUID of the retry action. Only set it if this is a retry
+      # for an existing resource. This is for the user re-populate the resource
+      # without changes. An error will be returned if the retry_uuid is set but
+      # the resource get modified.
+}
+
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so
 that if you must retry your request, the server will know to ignore the
 request if it has already been completed.
@@ -388,29 +413,6 @@ 
Method Details

 The request ID must be
 a valid UUID with the exception that zero UUID is not supported
 (00000000-0000-0000-0000-000000000000).
-  rolloutInput_conflictBehavior: string, Optional. [Optional] Specifies the behavior of the Rollout if a conflict is
-detected in a project during a Rollout. It can be one of the following
-values:
-1) empty : don't overwrite the local value if conflict happens. This is
-the default behavior.
-2) "overwrite" : Overwrite the local value with the rollout value.
-The concept of "conflict" applies to:
-1) Insert action. If the zonal policy already exists when Insert
-happens, it's a conflict.
-2) Update action. If the zonal policy was updated out of band by a
-zonal API, it's a conflict.
-  rolloutInput_name: string, Optional. The name of the rollout plan.
-Ex.
-projects//locations/global/rolloutPlans/.
-  rolloutInput_predefinedRolloutPlan: string, Optional. Predefined rollout plan.
-    Allowed values
-      FAST_ROLLOUT - 
-      ROLLOUT_PLAN_UNSPECIFIED - 
-      SLOW_ROLLOUT - 
-  rolloutInput_retryUuid: string, Optional. The UUID of the retry action. Only set it if this is a retry
-for an existing resource. This is for the user re-populate the resource
-without changes. An error will be returned if the retry_uuid is set but
-the resource get modified.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/compute_alpha.haControllers.html b/docs/dyn/compute_alpha.haControllers.html
index 589474e32e..5039b7b561 100644
--- a/docs/dyn/compute_alpha.haControllers.html
+++ b/docs/dyn/compute_alpha.haControllers.html
@@ -74,6 +74,12 @@
 
 
Compute Engine API . haControllers

 
Instance Methods

+

+  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+
Retrieves an aggregated list of all of the HaControllers in the specified

+

+  aggregatedList_next()

+
Retrieves the next page of results.

 

   close()

 
Close httplib2 connections.

@@ -99,6 +105,630 @@ 
Instance Methods

   patch(project, region, haController, body=None, requestId=None, updateMask=None, x__xgafv=None)

 
Updates HaController in the specified project.

 
Method Details

+

+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+  
Retrieves an aggregated list of all of the HaControllers in the specified
+project across all regions.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of HaControllersScopedList resources.
+    "a_key": { # Name of the scope containing this set of ha controllers.
+      "haControllers": [ # List of HaControllers contained in this scope.
+        { # HaController handles failover for a VM Instance.
+          "backendServices": [ # Advanced configuration option. If specified, these Backend Services need to
+              # be pre-created and configured as managed.
+            "A String",
+          ],
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource. Provide this property when you
+              # create the resource.
+          "failoverInitiation": "A String", # Indicates how failover should be initiated.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+              # defined by the server.
+          "instanceName": "A String", # Name of the instance that HaController is in charge of.
+              # If not specified the HaController's resource name will be used instead.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
+              # must be a lowercase letter, and all following characters must be a dash,
+              # lowercase letter, or digit, except the last character, which cannot be a
+              # dash.
+          "kind": "compute#HaController", # [Output Only] Type of the resource. Alwayscompute#haController for HaControllers.
+          "name": "A String", # Name of the resource.
+              # Provided by the client when the resource is created.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character
+              # must be a lowercase letter, and all following characters must be a dash,
+              # lowercase letter, or digit, except the last character, which cannot be a
+              # dash.
+          "networkingAutoConfiguration": { # Basic networking configuration. Required backend services and forwarding # Basic networking configuration. Required backend services and forwarding
+              # rules will be automatically created with default parameters.
+              # rules will be automatically created with default parameters.
+            "internal": { # Internal networking configuration # Internal networking configuration
+              "ipAddress": "A String", # Optional. IP addresses will be automatically allocated according to
+                  # StackType if not provided.
+              "ipv6Address": "A String",
+              "stackType": "A String", # Determine which IP addresses to automatically create. Field and option
+                  # naming consistent with NetworkInterface configuration on Instances.
+            },
+          },
+          "region": "A String", # [Output Only] URL of the region where the resource resides.
+              # You must specify this field as part of the HTTP request URL.
+              # It is not settable as a field in the request body.
+          "secondaryZoneCapacity": "A String", # Indicates the capacity guarantees in the secondary zone.
+          "selfLink": "A String", # [Output only] Server-defined URL for the resource.
+          "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+          "status": { # Contains information about current status of the HaController. # [Output Only] Status information for the HaController resource.
+            "failoverProgress": { # Contains information about the current failover operation. # [Output Only] Contains the details of the ongoing failover. This message
+                # is not displayed if failover is NOT in progress.
+              "failoverCompleteTimestamp": "A String", # [Output Only] Timestamp of the failover completion.
+                  # Filled only if the failover is completed, in lastFailoverInfo.
+              "failoverTrigger": "A String", # [Output Only] Indicates if failover has been triggered automatically or
+                  # manually.
+              "failoverTriggerTimestamp": "A String", # [Output Only] Timestamp of the last failover trigger.
+              "lastFailoverAttempt": { # [Output Only] Contains details of the last failed failover. This field
+                  # is filled only if the current failover is failing
+                "errors": { # [Output Only] Encountered errors during the last attempt to process
+                    # failover.
+                  "errors": [ # [Output Only] The array of errors encountered while processing this
+                      # operation.
+                    {
+                      "code": "A String", # [Output Only] The error type identifier for this error.
+                      "errorDetails": [ # [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.
+                        {
+                          "errorInfo": { # Describes the cause of the error with structured details.
+                              #
+                              # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                              # is not enabled:
+                              #
+                              #     { "reason": "API_DISABLED"
+                              #       "domain": "googleapis.com"
+                              #       "metadata": {
+                              #         "resource": "projects/123",
+                              #         "service": "pubsub.googleapis.com"
+                              #       }
+                              #     }
+                              #
+                              # This response indicates that the pubsub.googleapis.com API is not enabled.
+                              #
+                              # Example of an error that is returned when attempting to create a Spanner
+                              # instance in a region that is out of stock:
+                              #
+                              #     { "reason": "STOCKOUT"
+                              #       "domain": "spanner.googleapis.com",
+                              #       "metadata": {
+                              #         "availableRegions": "us-central1,us-east2"
+                              #       }
+                              #     }
+                            "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                                # is typically the registered service name of the tool or product that
+                                # generates the error. Example: "pubsub.googleapis.com". If the error is
+                                # generated by some common infrastructure, the error domain must be a
+                                # globally unique value that identifies the infrastructure. For Google API
+                                # infrastructure, the error domain is "googleapis.com".
+                            "metadatas": { # Additional structured details about this error.
+                                #
+                                # Keys must match a regular expression of `a-z+` but should
+                                # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                                # length. When identifying the current value of an exceeded limit, the units
+                                # should be contained in the key, not the value.  For example, rather than
+                                # `{"instanceLimit": "100/request"}`, should be returned as,
+                                # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                                # instances that can be created in a single (batch) request.
+                              "a_key": "A String",
+                            },
+                            "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                                # proximate cause of the error. Error reasons are unique within a particular
+                                # domain of errors. This should be at most 63 characters and match a
+                                # regular expression of `A-Z+[A-Z0-9]`, which represents
+                                # UPPER_SNAKE_CASE.
+                          },
+                          "help": { # Provides links to documentation or for performing an out of band action.
+                              #
+                              # For example, if a quota check failed with an error indicating the calling
+                              # project hasn't enabled the accessed service, this can contain a URL pointing
+                              # directly to the right place in the developer console to flip the bit.
+                            "links": [ # URL(s) pointing to additional information on handling the current error.
+                              { # Describes a URL link.
+                                "description": "A String", # Describes what the link offers.
+                                "url": "A String", # The URL of the link.
+                              },
+                            ],
+                          },
+                          "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                              # which can be attached to an RPC error.
+                            "locale": "A String", # The locale used following the specification defined at
+                                # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                                # Examples are: "en-US", "fr-CH", "es-MX"
+                            "message": "A String", # The localized error message in the above locale.
+                          },
+                          "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                            "dimensions": { # The map holding related quota dimensions.
+                              "a_key": "A String",
+                            },
+                            "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                                #  type or metric.
+                            "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                                # or metric.
+                            "limitName": "A String", # The name of the quota limit.
+                            "metricName": "A String", # The Compute Engine quota metric name.
+                            "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                          },
+                        },
+                      ],
+                      "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+                          # This property is optional.
+                      "message": "A String", # [Output Only] An optional, human-readable error message.
+                    },
+                  ],
+                },
+                "timestamp": "A String", # [Output Only] Show timestamp only if there is an error.RFC3339
+                    # text format.
+              },
+            },
+            "lastFailoverInfo": { # Contains information about the current failover operation. # [Output Only] Contains the details of the last successful failover.
+              "failoverCompleteTimestamp": "A String", # [Output Only] Timestamp of the failover completion.
+                  # Filled only if the failover is completed, in lastFailoverInfo.
+              "failoverTrigger": "A String", # [Output Only] Indicates if failover has been triggered automatically or
+                  # manually.
+              "failoverTriggerTimestamp": "A String", # [Output Only] Timestamp of the last failover trigger.
+              "lastFailoverAttempt": { # [Output Only] Contains details of the last failed failover. This field
+                  # is filled only if the current failover is failing
+                "errors": { # [Output Only] Encountered errors during the last attempt to process
+                    # failover.
+                  "errors": [ # [Output Only] The array of errors encountered while processing this
+                      # operation.
+                    {
+                      "code": "A String", # [Output Only] The error type identifier for this error.
+                      "errorDetails": [ # [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.
+                        {
+                          "errorInfo": { # Describes the cause of the error with structured details.
+                              #
+                              # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                              # is not enabled:
+                              #
+                              #     { "reason": "API_DISABLED"
+                              #       "domain": "googleapis.com"
+                              #       "metadata": {
+                              #         "resource": "projects/123",
+                              #         "service": "pubsub.googleapis.com"
+                              #       }
+                              #     }
+                              #
+                              # This response indicates that the pubsub.googleapis.com API is not enabled.
+                              #
+                              # Example of an error that is returned when attempting to create a Spanner
+                              # instance in a region that is out of stock:
+                              #
+                              #     { "reason": "STOCKOUT"
+                              #       "domain": "spanner.googleapis.com",
+                              #       "metadata": {
+                              #         "availableRegions": "us-central1,us-east2"
+                              #       }
+                              #     }
+                            "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                                # is typically the registered service name of the tool or product that
+                                # generates the error. Example: "pubsub.googleapis.com". If the error is
+                                # generated by some common infrastructure, the error domain must be a
+                                # globally unique value that identifies the infrastructure. For Google API
+                                # infrastructure, the error domain is "googleapis.com".
+                            "metadatas": { # Additional structured details about this error.
+                                #
+                                # Keys must match a regular expression of `a-z+` but should
+                                # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                                # length. When identifying the current value of an exceeded limit, the units
+                                # should be contained in the key, not the value.  For example, rather than
+                                # `{"instanceLimit": "100/request"}`, should be returned as,
+                                # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                                # instances that can be created in a single (batch) request.
+                              "a_key": "A String",
+                            },
+                            "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                                # proximate cause of the error. Error reasons are unique within a particular
+                                # domain of errors. This should be at most 63 characters and match a
+                                # regular expression of `A-Z+[A-Z0-9]`, which represents
+                                # UPPER_SNAKE_CASE.
+                          },
+                          "help": { # Provides links to documentation or for performing an out of band action.
+                              #
+                              # For example, if a quota check failed with an error indicating the calling
+                              # project hasn't enabled the accessed service, this can contain a URL pointing
+                              # directly to the right place in the developer console to flip the bit.
+                            "links": [ # URL(s) pointing to additional information on handling the current error.
+                              { # Describes a URL link.
+                                "description": "A String", # Describes what the link offers.
+                                "url": "A String", # The URL of the link.
+                              },
+                            ],
+                          },
+                          "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                              # which can be attached to an RPC error.
+                            "locale": "A String", # The locale used following the specification defined at
+                                # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                                # Examples are: "en-US", "fr-CH", "es-MX"
+                            "message": "A String", # The localized error message in the above locale.
+                          },
+                          "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                            "dimensions": { # The map holding related quota dimensions.
+                              "a_key": "A String",
+                            },
+                            "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                                #  type or metric.
+                            "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                                # or metric.
+                            "limitName": "A String", # The name of the quota limit.
+                            "metricName": "A String", # The Compute Engine quota metric name.
+                            "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                          },
+                        },
+                      ],
+                      "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+                          # This property is optional.
+                      "message": "A String", # [Output Only] An optional, human-readable error message.
+                    },
+                  ],
+                },
+                "timestamp": "A String", # [Output Only] Show timestamp only if there is an error.RFC3339
+                    # text format.
+              },
+            },
+            "ongoingFailover": True or False, # [Output Only]  Indicates if the failover is currently in-progress.
+            "primaryInstance": "A String", # [Output Only] The URL to the instance that is intended to be primary at
+                # this moment. Primary instance will be changed at the very beginning of a
+                # failover operation.
+            "primaryZone": "A String", # [Output Only] The name of the zone that is intended to be primary at this
+                # moment. Primary zone will be changed at the very beginning of a failover
+                # operation. The zone may not be operational in the middle of a failover
+                # operation.
+            "readyForFailover": True or False, # [Output Only] Indicates if the resource is ready for initiating a
+                # failover to the secondary zone.
+            "zoneStatus": { # [Output Only] Map of zone statuses.
+                # Key: name of the zone
+                # Value: ZoneStatus
+              "a_key": { # Contains the status of a specific zone.
+                "isPrimary": True or False, # [Output Only] Indicates if the zone is primary at this moment.
+                "isZoneReady": True or False, # [Output Only] Indicates if the zone is ready for initiating a failover.
+                "lastError": { # Contains details of the last failed operation. # [Output Only] This field is filled only if the current operation is
+                    # failing.
+                  "errors": { # [Output Only] Encountered errors.
+                    "errors": [ # [Output Only] The array of errors encountered while processing this
+                        # operation.
+                      {
+                        "code": "A String", # [Output Only] The error type identifier for this error.
+                        "errorDetails": [ # [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.
+                          {
+                            "errorInfo": { # Describes the cause of the error with structured details.
+                                #
+                                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                                # is not enabled:
+                                #
+                                #     { "reason": "API_DISABLED"
+                                #       "domain": "googleapis.com"
+                                #       "metadata": {
+                                #         "resource": "projects/123",
+                                #         "service": "pubsub.googleapis.com"
+                                #       }
+                                #     }
+                                #
+                                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                                #
+                                # Example of an error that is returned when attempting to create a Spanner
+                                # instance in a region that is out of stock:
+                                #
+                                #     { "reason": "STOCKOUT"
+                                #       "domain": "spanner.googleapis.com",
+                                #       "metadata": {
+                                #         "availableRegions": "us-central1,us-east2"
+                                #       }
+                                #     }
+                              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                                  # is typically the registered service name of the tool or product that
+                                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                                  # generated by some common infrastructure, the error domain must be a
+                                  # globally unique value that identifies the infrastructure. For Google API
+                                  # infrastructure, the error domain is "googleapis.com".
+                              "metadatas": { # Additional structured details about this error.
+                                  #
+                                  # Keys must match a regular expression of `a-z+` but should
+                                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                                  # length. When identifying the current value of an exceeded limit, the units
+                                  # should be contained in the key, not the value.  For example, rather than
+                                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                                  # instances that can be created in a single (batch) request.
+                                "a_key": "A String",
+                              },
+                              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                                  # proximate cause of the error. Error reasons are unique within a particular
+                                  # domain of errors. This should be at most 63 characters and match a
+                                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                                  # UPPER_SNAKE_CASE.
+                            },
+                            "help": { # Provides links to documentation or for performing an out of band action.
+                                #
+                                # For example, if a quota check failed with an error indicating the calling
+                                # project hasn't enabled the accessed service, this can contain a URL pointing
+                                # directly to the right place in the developer console to flip the bit.
+                              "links": [ # URL(s) pointing to additional information on handling the current error.
+                                { # Describes a URL link.
+                                  "description": "A String", # Describes what the link offers.
+                                  "url": "A String", # The URL of the link.
+                                },
+                              ],
+                            },
+                            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                                # which can be attached to an RPC error.
+                              "locale": "A String", # The locale used following the specification defined at
+                                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                                  # Examples are: "en-US", "fr-CH", "es-MX"
+                              "message": "A String", # The localized error message in the above locale.
+                            },
+                            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                              "dimensions": { # The map holding related quota dimensions.
+                                "a_key": "A String",
+                              },
+                              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                                  #  type or metric.
+                              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                                  # or metric.
+                              "limitName": "A String", # The name of the quota limit.
+                              "metricName": "A String", # The Compute Engine quota metric name.
+                              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                            },
+                          },
+                        ],
+                        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+                            # This property is optional.
+                        "message": "A String", # [Output Only] An optional, human-readable error message.
+                      },
+                    ],
+                  },
+                  "timestamp": "A String", # [Output Only] Show timestamp only if there is an error.RFC3339
+                      # text format.
+                },
+              },
+            },
+          },
+          "zoneConfigurations": { # Map of zone configurations
+              # Key: name of the zone
+              # Value: ZoneConfiguration
+            "a_key": { # Config for a zone that the HaController may use for running the VM
+                # instance.
+              "nodeAffinities": [ # A set of node affinity configurations. Refer toConfiguring node
+                  # affinity for more information.
+                  # Overrides reservationAffinity.
+                { # Node Affinity: the configuration of desired nodes onto which the
+                    #  Instance could be scheduled.
+                    #  This message should be an exact copy of the Instances representation
+                    #  of NodeAffinity.
+                    # LINT.IfChange(HaControllerNodeAffinityMixer)
+                  "key": "A String", # Corresponds to the label key of Node resource.
+                  "operator": "A String", # Defines the operation of node selection. Valid operators areIN for affinity and NOT_IN for anti-affinity.
+                  "values": [ # Corresponds to the label values of Node resource.
+                    "A String",
+                  ],
+                },
+              ],
+              "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Specifies the reservations that the instance can consume from.
+                  # This message should be an exact copy of the Instances representation
+                  # of AllocationAffinity.
+                  # LINT.IfChange(HaControllerAllocationAffinityMixer)
+                "consumeReservationType": "A String", # Specifies the type of reservation from which this instance can consume
+                    # resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See
+                    # Consuming reserved instances for examples.
+                "key": "A String", # Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify
+                    # the name of your reservation as its value.
+                "values": [ # Corresponds to the label values of a reservation resource. This can be
+                    # either a name to a reservation in the same project or
+                    # "projects/different-project/reservations/some-reservation-name" to
+                    # target a shared reservation in the same zone but in a different
+                    # project.
+                  "A String",
+                ],
+              },
+            },
+          },
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # backend services when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#haControllersAggregatedList", # [Output Only] Type of resource. Alwayscompute#haControllersAggregatedList for lists of
+      # HaControllers.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}

+

+
+

+    aggregatedList_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
 

     close()
   
Close httplib2 connections.

@@ -389,7 +1019,9 @@ 
Method Details

     The object takes the form of:
 
 {
+  "failoverToZone": "A String", # Name of the destination zone for the failover.
   "primaryZone": "A String", # Name of the destination zone for the failover.
+      # Deprecated: use failover_to_zone instead.
 }
 
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so
diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html
index 2b8890e9ee..d9f1bcfd71 100644
--- a/docs/dyn/compute_alpha.html
+++ b/docs/dyn/compute_alpha.html
@@ -599,6 +599,16 @@ 
Instance Methods

 

 
Returns the resourcePolicies Resource.

 
+

+  rolloutPlans()
+

+
Returns the rolloutPlans Resource.

+
+

+  rollouts()
+

+
Returns the rollouts Resource.

+
 

   routers()
 

diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html
index e3f741be51..9e45d7aac7 100644
--- a/docs/dyn/compute_alpha.instanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.instanceGroupManagers.html
@@ -783,9 +783,498 @@ 
Method Details

             "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
                 # when creating new VMs.
               "a_key": {
+                "disks": [ # List of disks to be attached to the instances created from this
+                    # selection.
+                  { # An instance-attached disk resource.
+                    "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                        # or X86_64.
+                    "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                        # deleted (but not when the disk is detached from the instance).
+                    "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                        # partition of the disk for its root filesystem.
+                    "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                        # running within the instance. This name can be used to reference the device
+                        # for mounting, resizing, and so on, from within the instance.
+                        #
+                        # If not specified, the server chooses a default device name to apply to this
+                        # disk, in the form persistent-disk-x, where x is a number
+                        # assigned by Google Compute Engine. This field is only applicable for
+                        # persistent disks.
+                    "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                        # encryption key.
+                        #
+                        # If you are creating a new disk, this field encrypts the new disk using
+                        # an encryption key that you provide. If you are attaching an existing
+                        # disk that is already encrypted, this field decrypts the disk using
+                        # the customer-supplied encryption key.
+                        #
+                        # If you encrypt a disk using a customer-supplied key, you must provide the
+                        # same key again when you attempt to use this resource at a later time. For
+                        # example, you must provide the key when you create a snapshot or an image
+                        # from the disk or when you attach the disk to a virtual machine instance.
+                        #
+                        # If you do not provide an encryption key, then the disk will be encrypted
+                        # using an automatically generated key and you do not need to provide a key
+                        # to use the disk later.
+                        #
+                        # Note:
+                        #
+                        # Instance templates do not storecustomer-supplied
+                        # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                        #
+                        # You cannot create VMs that have disks with customer-supplied keys using
+                        # the bulk
+                        # insert method.
+                      "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                          # For example:
+                          #
+                          # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                          # key_region/cryptoKeys/key
+                          #
+                          # The fully-qualifed key name may be returned for resource GET requests. For
+                          # example:
+                          #
+                          # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                          # key_region/cryptoKeys/key
+                          # /cryptoKeyVersions/1
+                      "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                          # key. If absent, the Compute Engine default service account is used.
+                          # For example:
+                          #
+                          # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                      "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                          # encryption key, encoded in RFC
+                          # 4648 base64 to either encrypt or decrypt this resource. You can
+                          # provide either the rawKey or thersaEncryptedKey.
+                          # For example:
+                          #
+                          # "rawKey":
+                          # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                          # customer-supplied encryption key to either encrypt or decrypt this
+                          # resource. You can provide either the rawKey or thersaEncryptedKey.
+                          # For example:
+                          #
+                          # "rsaEncryptedKey":
+                          # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                          # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                          # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                          #
+                          # The key must meet the following requirements before you can provide it to
+                          # Compute Engine:
+                          #
+                          #    1. The key is wrapped using a RSA public key certificate provided by
+                          #    Google.
+                          #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                          #    encoding.
+                          #
+                          # Gets the RSA public key certificate provided by Google at:
+                          #
+                          #
+                          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                      "sha256": "A String", # [Output only] TheRFC
+                          # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                          # encryption key that protects this resource.
+                    },
+                    "diskSizeGb": "A String", # The size of the disk in GB.
+                    "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                        # currently attached to another instance. If you try to force attach a zonal
+                        # disk to an instance, you will receive an error.
+                    "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                        # only for bootable images. Read
+                        # Enabling guest operating system features to see a list of available
+                        # options.
+                      { # Guest OS features.
+                        "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                            # separate values. Set to one or more of the following values:
+                            #
+                            #    - VIRTIO_SCSI_MULTIQUEUE
+                            #    - WINDOWS
+                            #    - MULTI_IP_SUBNET
+                            #    - UEFI_COMPATIBLE
+                            #    - GVNIC
+                            #    - SEV_CAPABLE
+                            #    - SUSPEND_RESUME_COMPATIBLE
+                            #    - SEV_LIVE_MIGRATABLE_V2
+                            #    - SEV_SNP_CAPABLE
+                            #    - TDX_CAPABLE
+                            #    - IDPF
+                            #    - SNP_SVSM_CAPABLE
+                            #
+                            #
+                            # For more information, see
+                            # Enabling guest operating system features.
+                      },
+                    ],
+                    "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                        # boot disk. If you have many disks attached to an instance, each
+                        # disk would have a unique index number.
+                    "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                        # alongside the new instance. Use initialization parameters to create boot
+                        # disks or local SSDs attached to the new instance.
+                        #
+                        # This property is mutually exclusive with the source property;
+                        # you can only define one or the other, but not both.
+                        # alongside the new instance. Use initialization parameters to create boot
+                        # disks or local SSDs attached to the new instance.
+                        #
+                        # This field is persisted and returned for instanceTemplate and not returned
+                        # in the context of instance.
+                        #
+                        # This property is mutually exclusive with the source property;
+                        # you can only define one or the other, but not both.
+                      "architecture": "A String", # The architecture of the attached disk. Valid values are
+                          # arm64 or x86_64.
+                      "description": "A String", # An optional description. Provide this property when creating the disk.
+                      "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                          # of the instance. If a disk with the same name already exists in the given
+                          # region, the existing disk is attached to the new instance and the
+                          # new disk is not created.
+                      "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                          # 10 GB. If you specify a sourceImage, which is required for
+                          # boot disks, the default size is the size of the sourceImage.
+                          # If you do not specify a sourceImage, the default disk size
+                          # is 500 GB.
+                      "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                          # the default is pd-standard, specified using the full URL.
+                          # For example:
+                          #
+                          # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                          #
+                          #
+                          # For a full list of acceptable values, seePersistent disk
+                          # types. If you specify this field when creating a VM, you can provide
+                          # either the full or partial URL. For example, the following values are
+                          # valid:
+                          #
+                          #
+                          #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                          #    - projects/project/zones/zone/diskTypes/diskType
+                          #    - zones/zone/diskTypes/diskType
+                          #
+                          #
+                          # If you specify this field when creating or updating an instance template
+                          # or all-instances configuration, specify the type of the disk, not the
+                          # URL. For example: pd-standard.
+                      "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+                      "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                          # only for bootable images. Read
+                          # Enabling guest operating system features to see a list of available
+                          # options.
+                          #
+                          # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                        { # Guest OS features.
+                          "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                              # separate values. Set to one or more of the following values:
+                              #
+                              #    - VIRTIO_SCSI_MULTIQUEUE
+                              #    - WINDOWS
+                              #    - MULTI_IP_SUBNET
+                              #    - UEFI_COMPATIBLE
+                              #    - GVNIC
+                              #    - SEV_CAPABLE
+                              #    - SUSPEND_RESUME_COMPATIBLE
+                              #    - SEV_LIVE_MIGRATABLE_V2
+                              #    - SEV_SNP_CAPABLE
+                              #    - TDX_CAPABLE
+                              #    - IDPF
+                              #    - SNP_SVSM_CAPABLE
+                              #
+                              #
+                              # For more information, see
+                              # Enabling guest operating system features.
+                        },
+                      ],
+                      "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                          # which is either SCSI or NVME. The default isSCSI.
+                      "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                          # persistent disks.
+                        "a_key": "A String",
+                      },
+                      "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                          # disk.
+                        "A String",
+                      ],
+                      "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                        "A String",
+                      ],
+                      "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                          # more than one instance.
+                      "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                          # is to use the existing disk.
+                      "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                          # of I/O operations per second that the disk can handle. Values must be
+                          # between 10,000 and 120,000. For more details, see theExtreme persistent
+                          # disk documentation.
+                      "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                          # number of throughput mb per second that the disk can handle. Values must
+                          # greater than or equal to 1.
+                      "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                          # the URLs of the zones where the disk should be replicated to.
+                          # You must provide exactly two replica zones, and one zone must be the same
+                          # as the instance zone.
+                        "A String",
+                      ],
+                      "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                          # have the same definition as resource
+                          # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                          # values are in the format `tagValues/456`. The field is ignored (both PUT
+                          # & PATCH) when empty.
+                        "a_key": "A String",
+                      },
+                      "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                          # Specified using the full or partial URL. For instance template, specify
+                          # only the resource policy name.
+                        "A String",
+                      ],
+                      "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                          # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                          # is required.
+                          #
+                          # To create a disk with one of the public operating system
+                          # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                          #
+                          # projects/debian-cloud/global/images/family/debian-9
+                          #
+                          #
+                          # Alternatively, use a specific version of a public operating system image:
+                          #
+                          # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                          #
+                          #
+                          # To create a disk with a custom image that you created, specify the
+                          # image name in the following format:
+                          #
+                          # global/images/my-custom-image
+                          #
+                          #
+                          # You can also specify a custom image by its image family, which returns
+                          # the latest version of the image in that family. Replace the image name
+                          # with family/family-name:
+                          #
+                          # global/images/family/my-image-family
+                          #
+                          #
+                          # If the source image is deleted later, this field will not be set.
+                      "sourceImageEncryptionKey": { # Thecustomer-supplied
+                          # encryption key of the source image. Required if the source image is
+                          # protected by a customer-supplied encryption key.
+                          #
+                          # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                          # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                          # source images are encrypted with your own keys.
+                        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                            # For example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            #
+                            # The fully-qualifed key name may be returned for resource GET requests. For
+                            # example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            # /cryptoKeyVersions/1
+                        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                            # key. If absent, the Compute Engine default service account is used.
+                            # For example:
+                            #
+                            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                            # encryption key, encoded in RFC
+                            # 4648 base64 to either encrypt or decrypt this resource. You can
+                            # provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rawKey":
+                            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                            # customer-supplied encryption key to either encrypt or decrypt this
+                            # resource. You can provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rsaEncryptedKey":
+                            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                            #
+                            # The key must meet the following requirements before you can provide it to
+                            # Compute Engine:
+                            #
+                            #    1. The key is wrapped using a RSA public key certificate provided by
+                            #    Google.
+                            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                            #    encoding.
+                            #
+                            # Gets the RSA public key certificate provided by Google at:
+                            #
+                            #
+                            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                        "sha256": "A String", # [Output only] TheRFC
+                            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                            # encryption key that protects this resource.
+                      },
+                      "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                          # instance boot disk, one of initializeParams.sourceSnapshot
+                          # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                          # is required.
+                          #
+                          # To create a disk with a snapshot that you created, specify the
+                          # snapshot name in the following format:
+                          #
+                          # us-central1-a/instantSnapshots/my-backup
+                          #
+                          #
+                          # If the source instant-snapshot is deleted later, this field will not be
+                          # set.
+                      "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                          # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                          # is required.
+                          #
+                          # To create a disk with a snapshot that you created, specify the
+                          # snapshot name in the following format:
+                          #
+                          # global/snapshots/my-backup
+                          #
+                          #
+                          # If the source snapshot is deleted later, this field will not be set.
+                          #
+                          # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                          # an image instead when you create VMs using
+                          # the bulk
+                          # insert method.
+                      "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                          # encryption key of the source snapshot.
+                        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                            # For example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            #
+                            # The fully-qualifed key name may be returned for resource GET requests. For
+                            # example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            # /cryptoKeyVersions/1
+                        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                            # key. If absent, the Compute Engine default service account is used.
+                            # For example:
+                            #
+                            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                            # encryption key, encoded in RFC
+                            # 4648 base64 to either encrypt or decrypt this resource. You can
+                            # provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rawKey":
+                            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                            # customer-supplied encryption key to either encrypt or decrypt this
+                            # resource. You can provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rsaEncryptedKey":
+                            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                            #
+                            # The key must meet the following requirements before you can provide it to
+                            # Compute Engine:
+                            #
+                            #    1. The key is wrapped using a RSA public key certificate provided by
+                            #    Google.
+                            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                            #    encoding.
+                            #
+                            # Gets the RSA public key certificate provided by Google at:
+                            #
+                            #
+                            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                        "sha256": "A String", # [Output only] TheRFC
+                            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                            # encryption key that protects this resource.
+                      },
+                      "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                          # this as a partial or full URL to the resource. For example, the following
+                          # are valid values:
+                          #
+                          #
+                          #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                          #      - projects/project/zones/zone/storagePools/storagePool
+                          #    - zones/zone/storagePools/storagePool
+                    },
+                    "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                        # either SCSI or NVME. For most machine types, the
+                        # default is SCSI. Local SSDs can use either NVME or SCSI.
+                        # In certain configurations, persistent disks can use NVMe. For more
+                        # information, seeAbout
+                        # persistent disks.
+                    "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+                    "licenses": [ # [Output Only] Any valid publicly visible licenses.
+                      "A String",
+                    ],
+                    "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                        # disk is not allowed to be detached from the instance, or to be used as the
+                        # source of the snapshot creation, and the image creation. The instance with
+                        # at least one locked attached disk is not allow to be used as source of
+                        # machine image creation, instant snapshot creation, and not allowed to be
+                        # deleted with --keep-disk parameter set to true for locked disks.
+                    "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                        # in READ_WRITE mode.
+                    "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                        # field is set to PRESERVED if the LocalSSD data has been saved
+                        # to a persistent location by customer request.  (see the
+                        # discard_local_ssd option on Stop/Suspend).
+                        # Read-only in the api.
+                    "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                        # these are public keys which are safe to store in public
+                      "dbs": [ # The Key Database (db).
+                        {
+                          "content": "A String", # The raw content in the secure keys file.
+                          "fileType": "A String", # The file type of source file.
+                        },
+                      ],
+                      "dbxs": [ # The forbidden key database (dbx).
+                        {
+                          "content": "A String", # The raw content in the secure keys file.
+                          "fileType": "A String", # The file type of source file.
+                        },
+                      ],
+                      "keks": [ # The Key Exchange Key (KEK).
+                        {
+                          "content": "A String", # The raw content in the secure keys file.
+                          "fileType": "A String", # The file type of source file.
+                        },
+                      ],
+                      "pk": { # The Platform Key (PK).
+                        "content": "A String", # The raw content in the secure keys file.
+                        "fileType": "A String", # The file type of source file.
+                      },
+                    },
+                    "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                        # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                        # is required.
+                        #
+                        # If desired, you can also attach existing non-root persistent disks using
+                        # this property. This field is only applicable for persistent disks.
+                        #
+                        # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                        # and the URL for regional disk.
+                    "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+                    "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                        # URLs to the license resource. Unlike regular licenses, user provided
+                        # licenses can be modified after the disk is created.
+                      "A String",
+                    ],
+                  },
+                ],
                 "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
                   "A String",
                 ],
+                "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+                    # e.g. 'Intel Ice Lake'.
                 "rank": 42, # Preference of this instance selection. Lower number means higher
                     # preference. MIG will first try to create a VM based on the machine-type
                     # with lowest rank and fallback to next rank based on availability.
@@ -796,9 +1285,498 @@ 
Method Details

             "instanceSelections": { # Named instance selections configuring properties that the group will use
                 # when creating new VMs.
               "a_key": {
+                "disks": [ # List of disks to be attached to the instances created from this
+                    # selection.
+                  { # An instance-attached disk resource.
+                    "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                        # or X86_64.
+                    "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                        # deleted (but not when the disk is detached from the instance).
+                    "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                        # partition of the disk for its root filesystem.
+                    "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                        # running within the instance. This name can be used to reference the device
+                        # for mounting, resizing, and so on, from within the instance.
+                        #
+                        # If not specified, the server chooses a default device name to apply to this
+                        # disk, in the form persistent-disk-x, where x is a number
+                        # assigned by Google Compute Engine. This field is only applicable for
+                        # persistent disks.
+                    "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                        # encryption key.
+                        #
+                        # If you are creating a new disk, this field encrypts the new disk using
+                        # an encryption key that you provide. If you are attaching an existing
+                        # disk that is already encrypted, this field decrypts the disk using
+                        # the customer-supplied encryption key.
+                        #
+                        # If you encrypt a disk using a customer-supplied key, you must provide the
+                        # same key again when you attempt to use this resource at a later time. For
+                        # example, you must provide the key when you create a snapshot or an image
+                        # from the disk or when you attach the disk to a virtual machine instance.
+                        #
+                        # If you do not provide an encryption key, then the disk will be encrypted
+                        # using an automatically generated key and you do not need to provide a key
+                        # to use the disk later.
+                        #
+                        # Note:
+                        #
+                        # Instance templates do not storecustomer-supplied
+                        # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                        #
+                        # You cannot create VMs that have disks with customer-supplied keys using
+                        # the bulk
+                        # insert method.
+                      "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                          # For example:
+                          #
+                          # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                          # key_region/cryptoKeys/key
+                          #
+                          # The fully-qualifed key name may be returned for resource GET requests. For
+                          # example:
+                          #
+                          # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                          # key_region/cryptoKeys/key
+                          # /cryptoKeyVersions/1
+                      "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                          # key. If absent, the Compute Engine default service account is used.
+                          # For example:
+                          #
+                          # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                      "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                          # encryption key, encoded in RFC
+                          # 4648 base64 to either encrypt or decrypt this resource. You can
+                          # provide either the rawKey or thersaEncryptedKey.
+                          # For example:
+                          #
+                          # "rawKey":
+                          # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                      "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                          # customer-supplied encryption key to either encrypt or decrypt this
+                          # resource. You can provide either the rawKey or thersaEncryptedKey.
+                          # For example:
+                          #
+                          # "rsaEncryptedKey":
+                          # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                          # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                          # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                          #
+                          # The key must meet the following requirements before you can provide it to
+                          # Compute Engine:
+                          #
+                          #    1. The key is wrapped using a RSA public key certificate provided by
+                          #    Google.
+                          #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                          #    encoding.
+                          #
+                          # Gets the RSA public key certificate provided by Google at:
+                          #
+                          #
+                          # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                      "sha256": "A String", # [Output only] TheRFC
+                          # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                          # encryption key that protects this resource.
+                    },
+                    "diskSizeGb": "A String", # The size of the disk in GB.
+                    "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                        # currently attached to another instance. If you try to force attach a zonal
+                        # disk to an instance, you will receive an error.
+                    "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                        # only for bootable images. Read
+                        # Enabling guest operating system features to see a list of available
+                        # options.
+                      { # Guest OS features.
+                        "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                            # separate values. Set to one or more of the following values:
+                            #
+                            #    - VIRTIO_SCSI_MULTIQUEUE
+                            #    - WINDOWS
+                            #    - MULTI_IP_SUBNET
+                            #    - UEFI_COMPATIBLE
+                            #    - GVNIC
+                            #    - SEV_CAPABLE
+                            #    - SUSPEND_RESUME_COMPATIBLE
+                            #    - SEV_LIVE_MIGRATABLE_V2
+                            #    - SEV_SNP_CAPABLE
+                            #    - TDX_CAPABLE
+                            #    - IDPF
+                            #    - SNP_SVSM_CAPABLE
+                            #
+                            #
+                            # For more information, see
+                            # Enabling guest operating system features.
+                      },
+                    ],
+                    "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                        # boot disk. If you have many disks attached to an instance, each
+                        # disk would have a unique index number.
+                    "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                        # alongside the new instance. Use initialization parameters to create boot
+                        # disks or local SSDs attached to the new instance.
+                        #
+                        # This property is mutually exclusive with the source property;
+                        # you can only define one or the other, but not both.
+                        # alongside the new instance. Use initialization parameters to create boot
+                        # disks or local SSDs attached to the new instance.
+                        #
+                        # This field is persisted and returned for instanceTemplate and not returned
+                        # in the context of instance.
+                        #
+                        # This property is mutually exclusive with the source property;
+                        # you can only define one or the other, but not both.
+                      "architecture": "A String", # The architecture of the attached disk. Valid values are
+                          # arm64 or x86_64.
+                      "description": "A String", # An optional description. Provide this property when creating the disk.
+                      "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                          # of the instance. If a disk with the same name already exists in the given
+                          # region, the existing disk is attached to the new instance and the
+                          # new disk is not created.
+                      "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                          # 10 GB. If you specify a sourceImage, which is required for
+                          # boot disks, the default size is the size of the sourceImage.
+                          # If you do not specify a sourceImage, the default disk size
+                          # is 500 GB.
+                      "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                          # the default is pd-standard, specified using the full URL.
+                          # For example:
+                          #
+                          # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                          #
+                          #
+                          # For a full list of acceptable values, seePersistent disk
+                          # types. If you specify this field when creating a VM, you can provide
+                          # either the full or partial URL. For example, the following values are
+                          # valid:
+                          #
+                          #
+                          #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                          #    - projects/project/zones/zone/diskTypes/diskType
+                          #    - zones/zone/diskTypes/diskType
+                          #
+                          #
+                          # If you specify this field when creating or updating an instance template
+                          # or all-instances configuration, specify the type of the disk, not the
+                          # URL. For example: pd-standard.
+                      "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+                      "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                          # only for bootable images. Read
+                          # Enabling guest operating system features to see a list of available
+                          # options.
+                          #
+                          # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                        { # Guest OS features.
+                          "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                              # separate values. Set to one or more of the following values:
+                              #
+                              #    - VIRTIO_SCSI_MULTIQUEUE
+                              #    - WINDOWS
+                              #    - MULTI_IP_SUBNET
+                              #    - UEFI_COMPATIBLE
+                              #    - GVNIC
+                              #    - SEV_CAPABLE
+                              #    - SUSPEND_RESUME_COMPATIBLE
+                              #    - SEV_LIVE_MIGRATABLE_V2
+                              #    - SEV_SNP_CAPABLE
+                              #    - TDX_CAPABLE
+                              #    - IDPF
+                              #    - SNP_SVSM_CAPABLE
+                              #
+                              #
+                              # For more information, see
+                              # Enabling guest operating system features.
+                        },
+                      ],
+                      "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                          # which is either SCSI or NVME. The default isSCSI.
+                      "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                          # persistent disks.
+                        "a_key": "A String",
+                      },
+                      "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                          # disk.
+                        "A String",
+                      ],
+                      "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                        "A String",
+                      ],
+                      "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                          # more than one instance.
+                      "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                          # is to use the existing disk.
+                      "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                          # of I/O operations per second that the disk can handle. Values must be
+                          # between 10,000 and 120,000. For more details, see theExtreme persistent
+                          # disk documentation.
+                      "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                          # number of throughput mb per second that the disk can handle. Values must
+                          # greater than or equal to 1.
+                      "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                          # the URLs of the zones where the disk should be replicated to.
+                          # You must provide exactly two replica zones, and one zone must be the same
+                          # as the instance zone.
+                        "A String",
+                      ],
+                      "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                          # have the same definition as resource
+                          # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                          # values are in the format `tagValues/456`. The field is ignored (both PUT
+                          # & PATCH) when empty.
+                        "a_key": "A String",
+                      },
+                      "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                          # Specified using the full or partial URL. For instance template, specify
+                          # only the resource policy name.
+                        "A String",
+                      ],
+                      "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                          # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                          # is required.
+                          #
+                          # To create a disk with one of the public operating system
+                          # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                          #
+                          # projects/debian-cloud/global/images/family/debian-9
+                          #
+                          #
+                          # Alternatively, use a specific version of a public operating system image:
+                          #
+                          # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                          #
+                          #
+                          # To create a disk with a custom image that you created, specify the
+                          # image name in the following format:
+                          #
+                          # global/images/my-custom-image
+                          #
+                          #
+                          # You can also specify a custom image by its image family, which returns
+                          # the latest version of the image in that family. Replace the image name
+                          # with family/family-name:
+                          #
+                          # global/images/family/my-image-family
+                          #
+                          #
+                          # If the source image is deleted later, this field will not be set.
+                      "sourceImageEncryptionKey": { # Thecustomer-supplied
+                          # encryption key of the source image. Required if the source image is
+                          # protected by a customer-supplied encryption key.
+                          #
+                          # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                          # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                          # source images are encrypted with your own keys.
+                        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                            # For example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            #
+                            # The fully-qualifed key name may be returned for resource GET requests. For
+                            # example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            # /cryptoKeyVersions/1
+                        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                            # key. If absent, the Compute Engine default service account is used.
+                            # For example:
+                            #
+                            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                            # encryption key, encoded in RFC
+                            # 4648 base64 to either encrypt or decrypt this resource. You can
+                            # provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rawKey":
+                            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                            # customer-supplied encryption key to either encrypt or decrypt this
+                            # resource. You can provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rsaEncryptedKey":
+                            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                            #
+                            # The key must meet the following requirements before you can provide it to
+                            # Compute Engine:
+                            #
+                            #    1. The key is wrapped using a RSA public key certificate provided by
+                            #    Google.
+                            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                            #    encoding.
+                            #
+                            # Gets the RSA public key certificate provided by Google at:
+                            #
+                            #
+                            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                        "sha256": "A String", # [Output only] TheRFC
+                            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                            # encryption key that protects this resource.
+                      },
+                      "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                          # instance boot disk, one of initializeParams.sourceSnapshot
+                          # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                          # is required.
+                          #
+                          # To create a disk with a snapshot that you created, specify the
+                          # snapshot name in the following format:
+                          #
+                          # us-central1-a/instantSnapshots/my-backup
+                          #
+                          #
+                          # If the source instant-snapshot is deleted later, this field will not be
+                          # set.
+                      "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                          # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                          # is required.
+                          #
+                          # To create a disk with a snapshot that you created, specify the
+                          # snapshot name in the following format:
+                          #
+                          # global/snapshots/my-backup
+                          #
+                          #
+                          # If the source snapshot is deleted later, this field will not be set.
+                          #
+                          # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                          # an image instead when you create VMs using
+                          # the bulk
+                          # insert method.
+                      "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                          # encryption key of the source snapshot.
+                        "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                            # For example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            #
+                            # The fully-qualifed key name may be returned for resource GET requests. For
+                            # example:
+                            #
+                            # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                            # key_region/cryptoKeys/key
+                            # /cryptoKeyVersions/1
+                        "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                            # key. If absent, the Compute Engine default service account is used.
+                            # For example:
+                            #
+                            # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                        "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                            # encryption key, encoded in RFC
+                            # 4648 base64 to either encrypt or decrypt this resource. You can
+                            # provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rawKey":
+                            # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                        "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                            # customer-supplied encryption key to either encrypt or decrypt this
+                            # resource. You can provide either the rawKey or thersaEncryptedKey.
+                            # For example:
+                            #
+                            # "rsaEncryptedKey":
+                            # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                            # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                            # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                            #
+                            # The key must meet the following requirements before you can provide it to
+                            # Compute Engine:
+                            #
+                            #    1. The key is wrapped using a RSA public key certificate provided by
+                            #    Google.
+                            #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                            #    encoding.
+                            #
+                            # Gets the RSA public key certificate provided by Google at:
+                            #
+                            #
+                            # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                        "sha256": "A String", # [Output only] TheRFC
+                            # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                            # encryption key that protects this resource.
+                      },
+                      "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                          # this as a partial or full URL to the resource. For example, the following
+                          # are valid values:
+                          #
+                          #
+                          #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                          #      - projects/project/zones/zone/storagePools/storagePool
+                          #    - zones/zone/storagePools/storagePool
+                    },
+                    "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                        # either SCSI or NVME. For most machine types, the
+                        # default is SCSI. Local SSDs can use either NVME or SCSI.
+                        # In certain configurations, persistent disks can use NVMe. For more
+                        # information, seeAbout
+                        # persistent disks.
+                    "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+                    "licenses": [ # [Output Only] Any valid publicly visible licenses.
+                      "A String",
+                    ],
+                    "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                        # disk is not allowed to be detached from the instance, or to be used as the
+                        # source of the snapshot creation, and the image creation. The instance with
+                        # at least one locked attached disk is not allow to be used as source of
+                        # machine image creation, instant snapshot creation, and not allowed to be
+                        # deleted with --keep-disk parameter set to true for locked disks.
+                    "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                        # in READ_WRITE mode.
+                    "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                        # field is set to PRESERVED if the LocalSSD data has been saved
+                        # to a persistent location by customer request.  (see the
+                        # discard_local_ssd option on Stop/Suspend).
+                        # Read-only in the api.
+                    "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                        # these are public keys which are safe to store in public
+                      "dbs": [ # The Key Database (db).
+                        {
+                          "content": "A String", # The raw content in the secure keys file.
+                          "fileType": "A String", # The file type of source file.
+                        },
+                      ],
+                      "dbxs": [ # The forbidden key database (dbx).
+                        {
+                          "content": "A String", # The raw content in the secure keys file.
+                          "fileType": "A String", # The file type of source file.
+                        },
+                      ],
+                      "keks": [ # The Key Exchange Key (KEK).
+                        {
+                          "content": "A String", # The raw content in the secure keys file.
+                          "fileType": "A String", # The file type of source file.
+                        },
+                      ],
+                      "pk": { # The Platform Key (PK).
+                        "content": "A String", # The raw content in the secure keys file.
+                        "fileType": "A String", # The file type of source file.
+                      },
+                    },
+                    "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                        # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                        # is required.
+                        #
+                        # If desired, you can also attach existing non-root persistent disks using
+                        # this property. This field is only applicable for persistent disks.
+                        #
+                        # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                        # and the URL for regional disk.
+                    "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+                    "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                        # URLs to the license resource. Unlike regular licenses, user provided
+                        # licenses can be modified after the disk is created.
+                      "A String",
+                    ],
+                  },
+                ],
                 "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
                   "A String",
                 ],
+                "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+                    # e.g. 'Intel Ice Lake'.
                 "rank": 42, # Preference of this instance selection. Lower number means higher
                     # preference. MIG will first try to create a VM based on the machine-type
                     # with lowest rank and fallback to next rank based on availability.
@@ -866,6 +1844,12 @@ 
Method Details

                 #    About repairing VMs in a MIG.
             "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
               "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+                  # Valid values are:
+                  #
+                  #    - NO (default): MIG cannot change a VM's zone during a
+                  #    repair.
+                  #    - YES: MIG can select a different zone for the VM during
+                  #    a repair.
             },
           },
           "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -3157,35 +4141,1013 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
-        "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
-          "A String",
-        ],
-        "rank": 42, # Preference of this instance selection. Lower number means higher
-            # preference. MIG will first try to create a VM based on the machine-type
-            # with lowest rank and fallback to next rank based on availability.
-            # Machine types and instance selections with the same rank have the same
-            # preference.
-      },
-    },
-    "instanceSelections": { # Named instance selections configuring properties that the group will use
-        # when creating new VMs.
-      "a_key": {
-        "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
-          "A String",
-        ],
-        "rank": 42, # Preference of this instance selection. Lower number means higher
-            # preference. MIG will first try to create a VM based on the machine-type
-            # with lowest rank and fallback to next rank based on availability.
-            # Machine types and instance selections with the same rank have the same
-            # preference.
-      },
-    },
-    "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to
-        # create instances.
-      "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of
-          # more preemption than the minimum capacity user needs. MIG will create
-          # only Standard VMs until it reaches standard_capacity_base and only
-          # then will start using standard_capacity_percent_above_base to mix Spot
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
+        "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+          "A String",
+        ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
+        "rank": 42, # Preference of this instance selection. Lower number means higher
+            # preference. MIG will first try to create a VM based on the machine-type
+            # with lowest rank and fallback to next rank based on availability.
+            # Machine types and instance selections with the same rank have the same
+            # preference.
+      },
+    },
+    "instanceSelections": { # Named instance selections configuring properties that the group will use
+        # when creating new VMs.
+      "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
+        "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
+          "A String",
+        ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
+        "rank": 42, # Preference of this instance selection. Lower number means higher
+            # preference. MIG will first try to create a VM based on the machine-type
+            # with lowest rank and fallback to next rank based on availability.
+            # Machine types and instance selections with the same rank have the same
+            # preference.
+      },
+    },
+    "provisioningModelMix": { # Provisioning model configuration used by this managed instance group to
+        # create instances.
+      "standardCapacityBase": 42, # The base capacity that will always use Standard VMs to avoid risk of
+          # more preemption than the minimum capacity user needs. MIG will create
+          # only Standard VMs until it reaches standard_capacity_base and only
+          # then will start using standard_capacity_percent_above_base to mix Spot
           # with Standard VMs.
       "standardCapacityPercentAboveBase": 42, # The percentage of target capacity that should use Standard VM. The
           # remaining percentage will use Spot VMs. The percentage applies only to
@@ -3240,6 +5202,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -3909,9 +5877,498 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -3922,9 +6379,498 @@ 
Method Details

     "instanceSelections": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -3992,6 +6938,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -4986,9 +7938,498 @@ 
Method Details

         "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
             # when creating new VMs.
           "a_key": {
+            "disks": [ # List of disks to be attached to the instances created from this
+                # selection.
+              { # An instance-attached disk resource.
+                "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                    # or X86_64.
+                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                    # deleted (but not when the disk is detached from the instance).
+                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                    # partition of the disk for its root filesystem.
+                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                    # running within the instance. This name can be used to reference the device
+                    # for mounting, resizing, and so on, from within the instance.
+                    #
+                    # If not specified, the server chooses a default device name to apply to this
+                    # disk, in the form persistent-disk-x, where x is a number
+                    # assigned by Google Compute Engine. This field is only applicable for
+                    # persistent disks.
+                "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                    # encryption key.
+                    #
+                    # If you are creating a new disk, this field encrypts the new disk using
+                    # an encryption key that you provide. If you are attaching an existing
+                    # disk that is already encrypted, this field decrypts the disk using
+                    # the customer-supplied encryption key.
+                    #
+                    # If you encrypt a disk using a customer-supplied key, you must provide the
+                    # same key again when you attempt to use this resource at a later time. For
+                    # example, you must provide the key when you create a snapshot or an image
+                    # from the disk or when you attach the disk to a virtual machine instance.
+                    #
+                    # If you do not provide an encryption key, then the disk will be encrypted
+                    # using an automatically generated key and you do not need to provide a key
+                    # to use the disk later.
+                    #
+                    # Note:
+                    #
+                    # Instance templates do not storecustomer-supplied
+                    # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                    #
+                    # You cannot create VMs that have disks with customer-supplied keys using
+                    # the bulk
+                    # insert method.
+                  "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                      # For example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      #
+                      # The fully-qualifed key name may be returned for resource GET requests. For
+                      # example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      # /cryptoKeyVersions/1
+                  "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                      # key. If absent, the Compute Engine default service account is used.
+                      # For example:
+                      #
+                      # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                  "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                      # encryption key, encoded in RFC
+                      # 4648 base64 to either encrypt or decrypt this resource. You can
+                      # provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rawKey":
+                      # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                      # customer-supplied encryption key to either encrypt or decrypt this
+                      # resource. You can provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rsaEncryptedKey":
+                      # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                      # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                      # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                      #
+                      # The key must meet the following requirements before you can provide it to
+                      # Compute Engine:
+                      #
+                      #    1. The key is wrapped using a RSA public key certificate provided by
+                      #    Google.
+                      #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                      #    encoding.
+                      #
+                      # Gets the RSA public key certificate provided by Google at:
+                      #
+                      #
+                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                  "sha256": "A String", # [Output only] TheRFC
+                      # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                      # encryption key that protects this resource.
+                },
+                "diskSizeGb": "A String", # The size of the disk in GB.
+                "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                    # currently attached to another instance. If you try to force attach a zonal
+                    # disk to an instance, you will receive an error.
+                "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                    # only for bootable images. Read
+                    # Enabling guest operating system features to see a list of available
+                    # options.
+                  { # Guest OS features.
+                    "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                        # separate values. Set to one or more of the following values:
+                        #
+                        #    - VIRTIO_SCSI_MULTIQUEUE
+                        #    - WINDOWS
+                        #    - MULTI_IP_SUBNET
+                        #    - UEFI_COMPATIBLE
+                        #    - GVNIC
+                        #    - SEV_CAPABLE
+                        #    - SUSPEND_RESUME_COMPATIBLE
+                        #    - SEV_LIVE_MIGRATABLE_V2
+                        #    - SEV_SNP_CAPABLE
+                        #    - TDX_CAPABLE
+                        #    - IDPF
+                        #    - SNP_SVSM_CAPABLE
+                        #
+                        #
+                        # For more information, see
+                        # Enabling guest operating system features.
+                  },
+                ],
+                "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                    # boot disk. If you have many disks attached to an instance, each
+                    # disk would have a unique index number.
+                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This field is persisted and returned for instanceTemplate and not returned
+                    # in the context of instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                  "architecture": "A String", # The architecture of the attached disk. Valid values are
+                      # arm64 or x86_64.
+                  "description": "A String", # An optional description. Provide this property when creating the disk.
+                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                      # of the instance. If a disk with the same name already exists in the given
+                      # region, the existing disk is attached to the new instance and the
+                      # new disk is not created.
+                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                      # 10 GB. If you specify a sourceImage, which is required for
+                      # boot disks, the default size is the size of the sourceImage.
+                      # If you do not specify a sourceImage, the default disk size
+                      # is 500 GB.
+                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                      # the default is pd-standard, specified using the full URL.
+                      # For example:
+                      #
+                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                      #
+                      #
+                      # For a full list of acceptable values, seePersistent disk
+                      # types. If you specify this field when creating a VM, you can provide
+                      # either the full or partial URL. For example, the following values are
+                      # valid:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                      #    - projects/project/zones/zone/diskTypes/diskType
+                      #    - zones/zone/diskTypes/diskType
+                      #
+                      #
+                      # If you specify this field when creating or updating an instance template
+                      # or all-instances configuration, specify the type of the disk, not the
+                      # URL. For example: pd-standard.
+                  "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+                  "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                      # only for bootable images. Read
+                      # Enabling guest operating system features to see a list of available
+                      # options.
+                      #
+                      # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                    { # Guest OS features.
+                      "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                          # separate values. Set to one or more of the following values:
+                          #
+                          #    - VIRTIO_SCSI_MULTIQUEUE
+                          #    - WINDOWS
+                          #    - MULTI_IP_SUBNET
+                          #    - UEFI_COMPATIBLE
+                          #    - GVNIC
+                          #    - SEV_CAPABLE
+                          #    - SUSPEND_RESUME_COMPATIBLE
+                          #    - SEV_LIVE_MIGRATABLE_V2
+                          #    - SEV_SNP_CAPABLE
+                          #    - TDX_CAPABLE
+                          #    - IDPF
+                          #    - SNP_SVSM_CAPABLE
+                          #
+                          #
+                          # For more information, see
+                          # Enabling guest operating system features.
+                    },
+                  ],
+                  "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                      # which is either SCSI or NVME. The default isSCSI.
+                  "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                      # persistent disks.
+                    "a_key": "A String",
+                  },
+                  "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                      # disk.
+                    "A String",
+                  ],
+                  "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                    "A String",
+                  ],
+                  "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                      # more than one instance.
+                  "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                      # is to use the existing disk.
+                  "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                      # of I/O operations per second that the disk can handle. Values must be
+                      # between 10,000 and 120,000. For more details, see theExtreme persistent
+                      # disk documentation.
+                  "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                      # number of throughput mb per second that the disk can handle. Values must
+                      # greater than or equal to 1.
+                  "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                      # the URLs of the zones where the disk should be replicated to.
+                      # You must provide exactly two replica zones, and one zone must be the same
+                      # as the instance zone.
+                    "A String",
+                  ],
+                  "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                      # have the same definition as resource
+                      # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                      # values are in the format `tagValues/456`. The field is ignored (both PUT
+                      # & PATCH) when empty.
+                    "a_key": "A String",
+                  },
+                  "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                      # Specified using the full or partial URL. For instance template, specify
+                      # only the resource policy name.
+                    "A String",
+                  ],
+                  "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                      # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                      # is required.
+                      #
+                      # To create a disk with one of the public operating system
+                      # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                      #
+                      # projects/debian-cloud/global/images/family/debian-9
+                      #
+                      #
+                      # Alternatively, use a specific version of a public operating system image:
+                      #
+                      # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                      #
+                      #
+                      # To create a disk with a custom image that you created, specify the
+                      # image name in the following format:
+                      #
+                      # global/images/my-custom-image
+                      #
+                      #
+                      # You can also specify a custom image by its image family, which returns
+                      # the latest version of the image in that family. Replace the image name
+                      # with family/family-name:
+                      #
+                      # global/images/family/my-image-family
+                      #
+                      #
+                      # If the source image is deleted later, this field will not be set.
+                  "sourceImageEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source image. Required if the source image is
+                      # protected by a customer-supplied encryption key.
+                      #
+                      # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                      # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                      # source images are encrypted with your own keys.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                      # instance boot disk, one of initializeParams.sourceSnapshot
+                      # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # us-central1-a/instantSnapshots/my-backup
+                      #
+                      #
+                      # If the source instant-snapshot is deleted later, this field will not be
+                      # set.
+                  "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                      # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # global/snapshots/my-backup
+                      #
+                      #
+                      # If the source snapshot is deleted later, this field will not be set.
+                      #
+                      # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                      # an image instead when you create VMs using
+                      # the bulk
+                      # insert method.
+                  "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source snapshot.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                      # this as a partial or full URL to the resource. For example, the following
+                      # are valid values:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                      #      - projects/project/zones/zone/storagePools/storagePool
+                      #    - zones/zone/storagePools/storagePool
+                },
+                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                    # either SCSI or NVME. For most machine types, the
+                    # default is SCSI. Local SSDs can use either NVME or SCSI.
+                    # In certain configurations, persistent disks can use NVMe. For more
+                    # information, seeAbout
+                    # persistent disks.
+                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+                "licenses": [ # [Output Only] Any valid publicly visible licenses.
+                  "A String",
+                ],
+                "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                    # disk is not allowed to be detached from the instance, or to be used as the
+                    # source of the snapshot creation, and the image creation. The instance with
+                    # at least one locked attached disk is not allow to be used as source of
+                    # machine image creation, instant snapshot creation, and not allowed to be
+                    # deleted with --keep-disk parameter set to true for locked disks.
+                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                    # in READ_WRITE mode.
+                "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                    # field is set to PRESERVED if the LocalSSD data has been saved
+                    # to a persistent location by customer request.  (see the
+                    # discard_local_ssd option on Stop/Suspend).
+                    # Read-only in the api.
+                "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                    # these are public keys which are safe to store in public
+                  "dbs": [ # The Key Database (db).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "dbxs": [ # The forbidden key database (dbx).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "keks": [ # The Key Exchange Key (KEK).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "pk": { # The Platform Key (PK).
+                    "content": "A String", # The raw content in the secure keys file.
+                    "fileType": "A String", # The file type of source file.
+                  },
+                },
+                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                    # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                    # is required.
+                    #
+                    # If desired, you can also attach existing non-root persistent disks using
+                    # this property. This field is only applicable for persistent disks.
+                    #
+                    # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                    # and the URL for regional disk.
+                "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+                "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                    # URLs to the license resource. Unlike regular licenses, user provided
+                    # licenses can be modified after the disk is created.
+                  "A String",
+                ],
+              },
+            ],
             "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
               "A String",
             ],
+            "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+                # e.g. 'Intel Ice Lake'.
             "rank": 42, # Preference of this instance selection. Lower number means higher
                 # preference. MIG will first try to create a VM based on the machine-type
                 # with lowest rank and fallback to next rank based on availability.
@@ -4999,9 +8440,498 @@ 
Method Details

         "instanceSelections": { # Named instance selections configuring properties that the group will use
             # when creating new VMs.
           "a_key": {
+            "disks": [ # List of disks to be attached to the instances created from this
+                # selection.
+              { # An instance-attached disk resource.
+                "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                    # or X86_64.
+                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                    # deleted (but not when the disk is detached from the instance).
+                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                    # partition of the disk for its root filesystem.
+                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                    # running within the instance. This name can be used to reference the device
+                    # for mounting, resizing, and so on, from within the instance.
+                    #
+                    # If not specified, the server chooses a default device name to apply to this
+                    # disk, in the form persistent-disk-x, where x is a number
+                    # assigned by Google Compute Engine. This field is only applicable for
+                    # persistent disks.
+                "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                    # encryption key.
+                    #
+                    # If you are creating a new disk, this field encrypts the new disk using
+                    # an encryption key that you provide. If you are attaching an existing
+                    # disk that is already encrypted, this field decrypts the disk using
+                    # the customer-supplied encryption key.
+                    #
+                    # If you encrypt a disk using a customer-supplied key, you must provide the
+                    # same key again when you attempt to use this resource at a later time. For
+                    # example, you must provide the key when you create a snapshot or an image
+                    # from the disk or when you attach the disk to a virtual machine instance.
+                    #
+                    # If you do not provide an encryption key, then the disk will be encrypted
+                    # using an automatically generated key and you do not need to provide a key
+                    # to use the disk later.
+                    #
+                    # Note:
+                    #
+                    # Instance templates do not storecustomer-supplied
+                    # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                    #
+                    # You cannot create VMs that have disks with customer-supplied keys using
+                    # the bulk
+                    # insert method.
+                  "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                      # For example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      #
+                      # The fully-qualifed key name may be returned for resource GET requests. For
+                      # example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      # /cryptoKeyVersions/1
+                  "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                      # key. If absent, the Compute Engine default service account is used.
+                      # For example:
+                      #
+                      # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                  "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                      # encryption key, encoded in RFC
+                      # 4648 base64 to either encrypt or decrypt this resource. You can
+                      # provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rawKey":
+                      # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                      # customer-supplied encryption key to either encrypt or decrypt this
+                      # resource. You can provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rsaEncryptedKey":
+                      # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                      # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                      # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                      #
+                      # The key must meet the following requirements before you can provide it to
+                      # Compute Engine:
+                      #
+                      #    1. The key is wrapped using a RSA public key certificate provided by
+                      #    Google.
+                      #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                      #    encoding.
+                      #
+                      # Gets the RSA public key certificate provided by Google at:
+                      #
+                      #
+                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                  "sha256": "A String", # [Output only] TheRFC
+                      # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                      # encryption key that protects this resource.
+                },
+                "diskSizeGb": "A String", # The size of the disk in GB.
+                "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                    # currently attached to another instance. If you try to force attach a zonal
+                    # disk to an instance, you will receive an error.
+                "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                    # only for bootable images. Read
+                    # Enabling guest operating system features to see a list of available
+                    # options.
+                  { # Guest OS features.
+                    "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                        # separate values. Set to one or more of the following values:
+                        #
+                        #    - VIRTIO_SCSI_MULTIQUEUE
+                        #    - WINDOWS
+                        #    - MULTI_IP_SUBNET
+                        #    - UEFI_COMPATIBLE
+                        #    - GVNIC
+                        #    - SEV_CAPABLE
+                        #    - SUSPEND_RESUME_COMPATIBLE
+                        #    - SEV_LIVE_MIGRATABLE_V2
+                        #    - SEV_SNP_CAPABLE
+                        #    - TDX_CAPABLE
+                        #    - IDPF
+                        #    - SNP_SVSM_CAPABLE
+                        #
+                        #
+                        # For more information, see
+                        # Enabling guest operating system features.
+                  },
+                ],
+                "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                    # boot disk. If you have many disks attached to an instance, each
+                    # disk would have a unique index number.
+                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This field is persisted and returned for instanceTemplate and not returned
+                    # in the context of instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                  "architecture": "A String", # The architecture of the attached disk. Valid values are
+                      # arm64 or x86_64.
+                  "description": "A String", # An optional description. Provide this property when creating the disk.
+                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                      # of the instance. If a disk with the same name already exists in the given
+                      # region, the existing disk is attached to the new instance and the
+                      # new disk is not created.
+                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                      # 10 GB. If you specify a sourceImage, which is required for
+                      # boot disks, the default size is the size of the sourceImage.
+                      # If you do not specify a sourceImage, the default disk size
+                      # is 500 GB.
+                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                      # the default is pd-standard, specified using the full URL.
+                      # For example:
+                      #
+                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                      #
+                      #
+                      # For a full list of acceptable values, seePersistent disk
+                      # types. If you specify this field when creating a VM, you can provide
+                      # either the full or partial URL. For example, the following values are
+                      # valid:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                      #    - projects/project/zones/zone/diskTypes/diskType
+                      #    - zones/zone/diskTypes/diskType
+                      #
+                      #
+                      # If you specify this field when creating or updating an instance template
+                      # or all-instances configuration, specify the type of the disk, not the
+                      # URL. For example: pd-standard.
+                  "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+                  "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                      # only for bootable images. Read
+                      # Enabling guest operating system features to see a list of available
+                      # options.
+                      #
+                      # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                    { # Guest OS features.
+                      "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                          # separate values. Set to one or more of the following values:
+                          #
+                          #    - VIRTIO_SCSI_MULTIQUEUE
+                          #    - WINDOWS
+                          #    - MULTI_IP_SUBNET
+                          #    - UEFI_COMPATIBLE
+                          #    - GVNIC
+                          #    - SEV_CAPABLE
+                          #    - SUSPEND_RESUME_COMPATIBLE
+                          #    - SEV_LIVE_MIGRATABLE_V2
+                          #    - SEV_SNP_CAPABLE
+                          #    - TDX_CAPABLE
+                          #    - IDPF
+                          #    - SNP_SVSM_CAPABLE
+                          #
+                          #
+                          # For more information, see
+                          # Enabling guest operating system features.
+                    },
+                  ],
+                  "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                      # which is either SCSI or NVME. The default isSCSI.
+                  "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                      # persistent disks.
+                    "a_key": "A String",
+                  },
+                  "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                      # disk.
+                    "A String",
+                  ],
+                  "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                    "A String",
+                  ],
+                  "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                      # more than one instance.
+                  "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                      # is to use the existing disk.
+                  "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                      # of I/O operations per second that the disk can handle. Values must be
+                      # between 10,000 and 120,000. For more details, see theExtreme persistent
+                      # disk documentation.
+                  "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                      # number of throughput mb per second that the disk can handle. Values must
+                      # greater than or equal to 1.
+                  "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                      # the URLs of the zones where the disk should be replicated to.
+                      # You must provide exactly two replica zones, and one zone must be the same
+                      # as the instance zone.
+                    "A String",
+                  ],
+                  "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                      # have the same definition as resource
+                      # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                      # values are in the format `tagValues/456`. The field is ignored (both PUT
+                      # & PATCH) when empty.
+                    "a_key": "A String",
+                  },
+                  "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                      # Specified using the full or partial URL. For instance template, specify
+                      # only the resource policy name.
+                    "A String",
+                  ],
+                  "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                      # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                      # is required.
+                      #
+                      # To create a disk with one of the public operating system
+                      # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                      #
+                      # projects/debian-cloud/global/images/family/debian-9
+                      #
+                      #
+                      # Alternatively, use a specific version of a public operating system image:
+                      #
+                      # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                      #
+                      #
+                      # To create a disk with a custom image that you created, specify the
+                      # image name in the following format:
+                      #
+                      # global/images/my-custom-image
+                      #
+                      #
+                      # You can also specify a custom image by its image family, which returns
+                      # the latest version of the image in that family. Replace the image name
+                      # with family/family-name:
+                      #
+                      # global/images/family/my-image-family
+                      #
+                      #
+                      # If the source image is deleted later, this field will not be set.
+                  "sourceImageEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source image. Required if the source image is
+                      # protected by a customer-supplied encryption key.
+                      #
+                      # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                      # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                      # source images are encrypted with your own keys.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                      # instance boot disk, one of initializeParams.sourceSnapshot
+                      # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # us-central1-a/instantSnapshots/my-backup
+                      #
+                      #
+                      # If the source instant-snapshot is deleted later, this field will not be
+                      # set.
+                  "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                      # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # global/snapshots/my-backup
+                      #
+                      #
+                      # If the source snapshot is deleted later, this field will not be set.
+                      #
+                      # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                      # an image instead when you create VMs using
+                      # the bulk
+                      # insert method.
+                  "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source snapshot.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                      # this as a partial or full URL to the resource. For example, the following
+                      # are valid values:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                      #      - projects/project/zones/zone/storagePools/storagePool
+                      #    - zones/zone/storagePools/storagePool
+                },
+                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                    # either SCSI or NVME. For most machine types, the
+                    # default is SCSI. Local SSDs can use either NVME or SCSI.
+                    # In certain configurations, persistent disks can use NVMe. For more
+                    # information, seeAbout
+                    # persistent disks.
+                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+                "licenses": [ # [Output Only] Any valid publicly visible licenses.
+                  "A String",
+                ],
+                "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                    # disk is not allowed to be detached from the instance, or to be used as the
+                    # source of the snapshot creation, and the image creation. The instance with
+                    # at least one locked attached disk is not allow to be used as source of
+                    # machine image creation, instant snapshot creation, and not allowed to be
+                    # deleted with --keep-disk parameter set to true for locked disks.
+                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                    # in READ_WRITE mode.
+                "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                    # field is set to PRESERVED if the LocalSSD data has been saved
+                    # to a persistent location by customer request.  (see the
+                    # discard_local_ssd option on Stop/Suspend).
+                    # Read-only in the api.
+                "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                    # these are public keys which are safe to store in public
+                  "dbs": [ # The Key Database (db).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "dbxs": [ # The forbidden key database (dbx).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "keks": [ # The Key Exchange Key (KEK).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "pk": { # The Platform Key (PK).
+                    "content": "A String", # The raw content in the secure keys file.
+                    "fileType": "A String", # The file type of source file.
+                  },
+                },
+                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                    # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                    # is required.
+                    #
+                    # If desired, you can also attach existing non-root persistent disks using
+                    # this property. This field is only applicable for persistent disks.
+                    #
+                    # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                    # and the URL for regional disk.
+                "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+                "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                    # URLs to the license resource. Unlike regular licenses, user provided
+                    # licenses can be modified after the disk is created.
+                  "A String",
+                ],
+              },
+            ],
             "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
               "A String",
             ],
+            "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+                # e.g. 'Intel Ice Lake'.
             "rank": 42, # Preference of this instance selection. Lower number means higher
                 # preference. MIG will first try to create a VM based on the machine-type
                 # with lowest rank and fallback to next rank based on availability.
@@ -5069,6 +8999,12 @@ 
Method Details

             #    About repairing VMs in a MIG.
         "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
           "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+              # Valid values are:
+              #
+              #    - NO (default): MIG cannot change a VM's zone during a
+              #    repair.
+              #    - YES: MIG can select a different zone for the VM during
+              #    a repair.
         },
       },
       "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -5874,7 +9810,495 @@ 
Method Details

           # instance has not yet been created.
       "instanceFlexibilityOverride": { # [Output Only] The overrides to instance properties resulting from
           # InstanceFlexibilityPolicy.
+        "disks": [ # List of disks to be attached to the instance.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineType": "A String", # The machine type to be used for this instance.
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance.
+            # e.g. 'Intel Ice Lake'.
         "provisioningModel": "A String", # The provisioning model to be used for this instance.
       },
       "instanceHealth": [ # [Output Only] Health state of the instance per health-check.
@@ -6581,22 +11005,1000 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
-        "rank": 42, # Preference of this instance selection. Lower number means higher
-            # preference. MIG will first try to create a VM based on the machine-type
-            # with lowest rank and fallback to next rank based on availability.
-            # Machine types and instance selections with the same rank have the same
-            # preference.
-      },
-    },
-    "instanceSelections": { # Named instance selections configuring properties that the group will use
-        # when creating new VMs.
-      "a_key": {
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
+        "rank": 42, # Preference of this instance selection. Lower number means higher
+            # preference. MIG will first try to create a VM based on the machine-type
+            # with lowest rank and fallback to next rank based on availability.
+            # Machine types and instance selections with the same rank have the same
+            # preference.
+      },
+    },
+    "instanceSelections": { # Named instance selections configuring properties that the group will use
+        # when creating new VMs.
+      "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -6664,6 +12066,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -11116,9 +16524,498 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -11129,9 +17026,498 @@ 
Method Details

     "instanceSelections": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -11199,6 +17585,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html
index eec00ccf66..4dd5ed6f38 100644
--- a/docs/dyn/compute_alpha.instanceTemplates.html
+++ b/docs/dyn/compute_alpha.instanceTemplates.html
@@ -1310,6 +1310,10 @@ 
Method Details

                 "A String",
               ],
             },
+            "workloadIdentityConfig": {
+              "identity": "A String",
+              "identityCertificateEnabled": True or False,
+            },
           },
           "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
               # applicable for regional resources.
@@ -2830,6 +2834,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
       # applicable for regional resources.
@@ -4347,6 +4355,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
       # applicable for regional resources.
@@ -5862,6 +5874,10 @@ 
Method Details

             "A String",
           ],
         },
+        "workloadIdentityConfig": {
+          "identity": "A String",
+          "identityCertificateEnabled": True or False,
+        },
       },
       "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
           # applicable for regional resources.
diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html
index 0692381713..a3a7224f8a 100644
--- a/docs/dyn/compute_alpha.instances.html
+++ b/docs/dyn/compute_alpha.instances.html
@@ -2940,6 +2940,10 @@ 
Method Details

             "windowStartTime": "A String", # The current start time of the maintenance window.
                 # This timestamp value is in RFC3339 text format.
           },
+          "workloadIdentityConfig": {
+            "identity": "A String",
+            "identityCertificateEnabled": True or False,
+          },
           "zone": "A String", # [Output Only] URL of the zone where the instance resides.
               # You must specify this field as part of the HTTP request URL. It is
               # not settable as a field in the request body.
@@ -5391,6 +5395,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
       # bulk.
@@ -8345,6 +8353,10 @@ 
Method Details

     "windowStartTime": "A String", # The current start time of the maintenance window.
         # This timestamp value is in RFC3339 text format.
   },
+  "workloadIdentityConfig": {
+    "identity": "A String",
+    "identityCertificateEnabled": True or False,
+  },
   "zone": "A String", # [Output Only] URL of the zone where the instance resides.
       # You must specify this field as part of the HTTP request URL. It is
       # not settable as a field in the request body.
@@ -11452,6 +11464,10 @@ 
Method Details

     "windowStartTime": "A String", # The current start time of the maintenance window.
         # This timestamp value is in RFC3339 text format.
   },
+  "workloadIdentityConfig": {
+    "identity": "A String",
+    "identityCertificateEnabled": True or False,
+  },
   "zone": "A String", # [Output Only] URL of the zone where the instance resides.
       # You must specify this field as part of the HTTP request URL. It is
       # not settable as a field in the request body.
@@ -13305,6 +13321,10 @@ 
Method Details

         "windowStartTime": "A String", # The current start time of the maintenance window.
             # This timestamp value is in RFC3339 text format.
       },
+      "workloadIdentityConfig": {
+        "identity": "A String",
+        "identityCertificateEnabled": True or False,
+      },
       "zone": "A String", # [Output Only] URL of the zone where the instance resides.
           # You must specify this field as part of the HTTP request URL. It is
           # not settable as a field in the request body.
@@ -23631,6 +23651,10 @@ 
Method Details

     "windowStartTime": "A String", # The current start time of the maintenance window.
         # This timestamp value is in RFC3339 text format.
   },
+  "workloadIdentityConfig": {
+    "identity": "A String",
+    "identityCertificateEnabled": True or False,
+  },
   "zone": "A String", # [Output Only] URL of the zone where the instance resides.
       # You must specify this field as part of the HTTP request URL. It is
       # not settable as a field in the request body.
diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html
index baaaf895f1..582bb51806 100644
--- a/docs/dyn/compute_alpha.interconnectAttachments.html
+++ b/docs/dyn/compute_alpha.interconnectAttachments.html
@@ -602,6 +602,8 @@ 
Method Details

               #    customer.
               #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
               #    the partner.
+              #
+              # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
           "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
               # Only specified at creation time.
         },
@@ -1364,6 +1366,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      #
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }

@@ -2123,6 +2127,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      # 
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }
@@ -2879,6 +2885,8 @@ 
Method Details

           #    customer.
           #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
           #    the partner.
+          #
+          # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
       "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
           # Only specified at creation time.
     },
@@ -3321,6 +3329,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      # 
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }
diff --git a/docs/dyn/compute_alpha.interconnectGroups.html b/docs/dyn/compute_alpha.interconnectGroups.html
index a5214e0739..9e720b903a 100644
--- a/docs/dyn/compute_alpha.interconnectGroups.html
+++ b/docs/dyn/compute_alpha.interconnectGroups.html
@@ -866,7 +866,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
@@ -1558,7 +1558,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
@@ -2042,7 +2042,7 @@ 
Method Details

           # If provided when patching a configuration in update mode, the provided
           # token must match the current token or the update is rejected. This provides
           # a reliable means of doing read-modify-write (optimistic locking) as
-          # described byAPI 154.
+          # described by AIP 154.
       "id": "A String", # [Output Only] The unique identifier for the resource type. The server
           # generates this identifier.
       "intent": { # The user's intent for this group. This is the only required field besides
@@ -2216,7 +2216,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html
index 6744b94409..d3101081e4 100644
--- a/docs/dyn/compute_alpha.machineImages.html
+++ b/docs/dyn/compute_alpha.machineImages.html
@@ -1476,6 +1476,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "kind": "compute#machineImage", # [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -3693,6 +3697,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "kind": "compute#machineImage", # [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
@@ -5904,6 +5912,10 @@ 
Method Details

             "A String",
           ],
         },
+        "workloadIdentityConfig": {
+          "identity": "A String",
+          "identityCertificateEnabled": True or False,
+        },
       },
       "kind": "compute#machineImage", # [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
       "labelFingerprint": "A String", # A fingerprint for the labels being applied to this machine image, which is
diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html
index a2c1684bc9..8104dd1e2d 100644
--- a/docs/dyn/compute_alpha.networkFirewallPolicies.html
+++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html
@@ -1381,7 +1381,7 @@ 
Method Details

 firewall policies from all applicable scopes (global and regional) and
 grouping the results per scope.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.networkProfiles.html b/docs/dyn/compute_alpha.networkProfiles.html
index cd75707e23..9eff82c0fc 100644
--- a/docs/dyn/compute_alpha.networkProfiles.html
+++ b/docs/dyn/compute_alpha.networkProfiles.html
@@ -116,6 +116,7 @@ 
Method Details

         # purposes are supported.
       "A String",
     ],
+    "allowAddressCreation": "A String", # Specifies whether address creation is allowed.
     "allowAliasIpRanges": "A String", # Specifies whether alias IP ranges (and secondary address ranges) are
         # allowed.
     "allowAutoModeSubnet": "A String", # Specifies whether auto mode subnet creation is allowed.
@@ -130,6 +131,8 @@ 
Method Details

     "allowIpForwarding": "A String", # Specifies whether IP forwarding is allowed.
     "allowLoadBalancing": "A String", # Specifies whether cloud load balancing is allowed.
     "allowMultiNicInSameNetwork": "A String", # Specifies whether multi-nic in the same network is allowed.
+    "allowMultiNicInSameSubnetwork": "A String", # Specifies whether multi-nic in the same subnetwork is allowed.
+    "allowMulticast": "A String", # Specifies whether multicast is allowed.
     "allowNcc": "A String", # Specifies whether NCC is allowed.
     "allowNetworkMigration": "A String", # Specifies whether VM network migration is allowed.
     "allowPacketMirroring": "A String", # Specifies whether Packet Mirroring 1.0 is supported.
@@ -138,6 +141,7 @@ 
Method Details

     "allowSameNetworkUnicast": "A String", # Specifies whether unicast within the same network is allowed.
     "allowStaticRoutes": "A String", # Specifies whether static route creation is allowed.
     "allowSubInterfaces": "A String", # Specifies whether sub interfaces are allowed.
+    "allowSubnetworkCreation": "A String", # Specifies whether subnetwork creation is allowed.
     "allowVpcFirewallRules": "A String", # Specifies whether VPC firewall rules can be created under the network.
     "allowVpcPeering": "A String", # Specifies whether VPC peering is allowed.
     "allowVpn": "A String", # Specifies whether VPN creation is allowed.
@@ -148,6 +152,14 @@ 
Method Details

         # empty, all interface types are supported.
       "A String",
     ],
+    "multicast": "A String", # Specifies which type of multicast is supported.
+    "predefinedNetworkInternalIpv6Range": "A String", # Specifies a predefined internal IPv6 range for the network.
+    "predefinedSubnetworkRanges": [ # Predefined subnetwork ranges for the network.
+      {
+        "ipv6Range": "A String", # The IPv6 range of the predefined subnetwork.
+        "namePrefix": "A String", # The naming prefix of the predefined subnetwork.
+      },
+    ],
     "subnetPurposes": [ # Specifies which subnetwork purposes are supported.
       "A String",
     ],
@@ -292,6 +304,7 @@ 
Method Details

             # purposes are supported.
           "A String",
         ],
+        "allowAddressCreation": "A String", # Specifies whether address creation is allowed.
         "allowAliasIpRanges": "A String", # Specifies whether alias IP ranges (and secondary address ranges) are
             # allowed.
         "allowAutoModeSubnet": "A String", # Specifies whether auto mode subnet creation is allowed.
@@ -306,6 +319,8 @@ 
Method Details

         "allowIpForwarding": "A String", # Specifies whether IP forwarding is allowed.
         "allowLoadBalancing": "A String", # Specifies whether cloud load balancing is allowed.
         "allowMultiNicInSameNetwork": "A String", # Specifies whether multi-nic in the same network is allowed.
+        "allowMultiNicInSameSubnetwork": "A String", # Specifies whether multi-nic in the same subnetwork is allowed.
+        "allowMulticast": "A String", # Specifies whether multicast is allowed.
         "allowNcc": "A String", # Specifies whether NCC is allowed.
         "allowNetworkMigration": "A String", # Specifies whether VM network migration is allowed.
         "allowPacketMirroring": "A String", # Specifies whether Packet Mirroring 1.0 is supported.
@@ -314,6 +329,7 @@ 
Method Details

         "allowSameNetworkUnicast": "A String", # Specifies whether unicast within the same network is allowed.
         "allowStaticRoutes": "A String", # Specifies whether static route creation is allowed.
         "allowSubInterfaces": "A String", # Specifies whether sub interfaces are allowed.
+        "allowSubnetworkCreation": "A String", # Specifies whether subnetwork creation is allowed.
         "allowVpcFirewallRules": "A String", # Specifies whether VPC firewall rules can be created under the network.
         "allowVpcPeering": "A String", # Specifies whether VPC peering is allowed.
         "allowVpn": "A String", # Specifies whether VPN creation is allowed.
@@ -324,6 +340,14 @@ 
Method Details

             # empty, all interface types are supported.
           "A String",
         ],
+        "multicast": "A String", # Specifies which type of multicast is supported.
+        "predefinedNetworkInternalIpv6Range": "A String", # Specifies a predefined internal IPv6 range for the network.
+        "predefinedSubnetworkRanges": [ # Predefined subnetwork ranges for the network.
+          {
+            "ipv6Range": "A String", # The IPv6 range of the predefined subnetwork.
+            "namePrefix": "A String", # The naming prefix of the predefined subnetwork.
+          },
+        ],
         "subnetPurposes": [ # Specifies which subnetwork purposes are supported.
           "A String",
         ],
diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html
index 10c93c1533..37782297db 100644
--- a/docs/dyn/compute_alpha.projects.html
+++ b/docs/dyn/compute_alpha.projects.html
@@ -109,7 +109,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   moveDisk(project, body=None, requestId=None, x__xgafv=None)

-
Starting September 29, 2025, you can't use the moveDisk API on new

+
Moves a persistent disk from one zone to another.

 

   moveInstance(project, body=None, requestId=None, x__xgafv=None)

 
Moves an instance and its attached persistent disks from one zone to

@@ -1885,10 +1885,13 @@ 
Method Details

 
 

     moveDisk(project, body=None, requestId=None, x__xgafv=None)
-  
Starting September 29, 2025, you can't use the moveDisk API on new
+  
Moves a persistent disk from one zone to another.
+*Note*: The moveDisk API will be deprecated on September 29, 2026.
+
+Starting September 29, 2025, you can't use the moveDisk API on new
 projects. To move a disk to a different region or zone, follow the steps in
 [Change the location of a
-disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
+disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
 
 Projects that already use the moveDisk API can continue usage until
 September 29, 2026.
diff --git a/docs/dyn/compute_alpha.regionBackendBuckets.html b/docs/dyn/compute_alpha.regionBackendBuckets.html
index c259c789d0..64e81f6215 100644
--- a/docs/dyn/compute_alpha.regionBackendBuckets.html
+++ b/docs/dyn/compute_alpha.regionBackendBuckets.html
@@ -518,7 +518,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1092,7 +1092,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1661,7 +1661,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1992,7 +1992,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2263,7 +2263,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html
index f31dbdf40c..faf8f152b0 100644
--- a/docs/dyn/compute_alpha.regionBackendServices.html
+++ b/docs/dyn/compute_alpha.regionBackendServices.html
@@ -488,7 +488,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -684,7 +685,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -876,7 +877,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -2081,25 +2083,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -2108,14 +2109,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
@@ -2666,7 +2667,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -2862,7 +2864,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -3054,7 +3056,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -4259,25 +4262,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -4286,14 +4288,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
@@ -4782,7 +4784,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -4978,7 +4981,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -5170,7 +5173,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -6375,25 +6379,24 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
-        "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
             #
             #
             # Use this property to configure the load balancer back-end to use
             # certificates and roots of trust provisioned by the Managed Workload
             # Identity system.
             #
-            #  The `managedIdentity` property is the
+            #  The `identity` property is the
             # fully-specified SPIFFE ID to use in the SVID presented by the Load
             # Balancer Workload.
             #
             #  The SPIFFE ID must be a resource starting with the
-            # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-            # followed by the path to the Managed Workload Identity.
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
             #
-            #  Supported
-            # SPIFFE ID format:
+            #  Supported SPIFFE ID format:
             #
-            #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
             #
             #
             # The Trust Domain within the Managed Identity must refer to a valid
@@ -6402,14 +6405,14 @@ 
Method Details

             #
             #  Restrictions:
             #
-            #    - If you set the `managedIdentity` property, you cannot manually set
+            #    - If you set the `identity` property, you cannot manually set
             #    the following fields:
             #        - tlsSettings.sni
             #       - tlsSettings.subjectAltNames
             #       - tlsSettings.authenticationConfig
             #
             #
-            # When defining a `managedIdentity` for a RegionBackendServices, the
+            # When defining a `identity` for a RegionBackendServices, the
             # corresponding Workload Identity Pool must have a ca_pool
             # configured in the same region.
             #
@@ -6660,7 +6663,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -6856,7 +6860,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -7048,7 +7052,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -8253,25 +8258,24 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
-        "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
             #
             #
             # Use this property to configure the load balancer back-end to use
             # certificates and roots of trust provisioned by the Managed Workload
             # Identity system.
             #
-            #  The `managedIdentity` property is the
+            #  The `identity` property is the
             # fully-specified SPIFFE ID to use in the SVID presented by the Load
             # Balancer Workload.
             #
             #  The SPIFFE ID must be a resource starting with the
-            # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-            # followed by the path to the Managed Workload Identity.
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
             #
-            #  Supported
-            # SPIFFE ID format:
+            #  Supported SPIFFE ID format:
             #
-            #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
             #
             #
             # The Trust Domain within the Managed Identity must refer to a valid
@@ -8280,14 +8284,14 @@ 
Method Details

             #
             #  Restrictions:
             #
-            #    - If you set the `managedIdentity` property, you cannot manually set
+            #    - If you set the `identity` property, you cannot manually set
             #    the following fields:
             #        - tlsSettings.sni
             #       - tlsSettings.subjectAltNames
             #       - tlsSettings.authenticationConfig
             #
             #
-            # When defining a `managedIdentity` for a RegionBackendServices, the
+            # When defining a `identity` for a RegionBackendServices, the
             # corresponding Workload Identity Pool must have a ca_pool
             # configured in the same region.
             #
@@ -8479,7 +8483,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -8675,7 +8680,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -8867,7 +8872,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -10072,25 +10078,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -10099,14 +10104,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
@@ -11708,7 +11713,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -11904,7 +11910,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -12096,7 +12102,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -13301,25 +13308,24 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
-    "identity": "A String", # Assigns the Managed Identity for the RegionBackendService Workload.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
         #
         #
         # Use this property to configure the load balancer back-end to use
         # certificates and roots of trust provisioned by the Managed Workload
         # Identity system.
         #
-        #  The `managedIdentity` property is the
+        #  The `identity` property is the
         # fully-specified SPIFFE ID to use in the SVID presented by the Load
         # Balancer Workload.
         #
         #  The SPIFFE ID must be a resource starting with the
-        # "spiffe" scheme identifier, followed by the "trustDomain" property value,
-        # followed by the path to the Managed Workload Identity.
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
         #
-        #  Supported
-        # SPIFFE ID format:
+        #  Supported SPIFFE ID format:
         #
-        #    - spiffe://<trust_domain>/ns/<namespace>/sa/<subject>
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
         #
         #
         # The Trust Domain within the Managed Identity must refer to a valid
@@ -13328,14 +13334,14 @@ 
Method Details

         #
         #  Restrictions:
         #
-        #    - If you set the `managedIdentity` property, you cannot manually set
+        #    - If you set the `identity` property, you cannot manually set
         #    the following fields:
         #        - tlsSettings.sni
         #       - tlsSettings.subjectAltNames
         #       - tlsSettings.authenticationConfig
         #
         #
-        # When defining a `managedIdentity` for a RegionBackendServices, the
+        # When defining a `identity` for a RegionBackendServices, the
         # corresponding Workload Identity Pool must have a ca_pool
         # configured in the same region.
         #
diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html
index a56f1c382e..47635218f9 100644
--- a/docs/dyn/compute_alpha.regionCommitments.html
+++ b/docs/dyn/compute_alpha.regionCommitments.html
@@ -115,7 +115,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of commitments by region.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.regionCompositeHealthChecks.html b/docs/dyn/compute_alpha.regionCompositeHealthChecks.html
index 702b46b212..fafd5f3f31 100644
--- a/docs/dyn/compute_alpha.regionCompositeHealthChecks.html
+++ b/docs/dyn/compute_alpha.regionCompositeHealthChecks.html
@@ -110,7 +110,7 @@ 
Method Details

   
Retrieves the list of all CompositeHealthCheck resources (all
 regional) available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html b/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html
index 7c64fd8ce0..3265d6b0e7 100644
--- a/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html
+++ b/docs/dyn/compute_alpha.regionHealthAggregationPolicies.html
@@ -110,7 +110,7 @@ 
Method Details

   
Retrieves the list of all HealthAggregationPolicy resources,
 regional and global, available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.regionHealthCheckServices.html b/docs/dyn/compute_alpha.regionHealthCheckServices.html
index bb32273457..338fe113ad 100644
--- a/docs/dyn/compute_alpha.regionHealthCheckServices.html
+++ b/docs/dyn/compute_alpha.regionHealthCheckServices.html
@@ -110,7 +110,7 @@ 
Method Details

   
Retrieves the list of all HealthCheckService resources,
 regional and global, available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
index 07ce6823f1..fe9ffd9c48 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
@@ -2234,9 +2234,498 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -2247,9 +2736,498 @@ 
Method Details

     "instanceSelections": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -2317,6 +3295,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -2953,22 +3937,1000 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
-        "rank": 42, # Preference of this instance selection. Lower number means higher
-            # preference. MIG will first try to create a VM based on the machine-type
-            # with lowest rank and fallback to next rank based on availability.
-            # Machine types and instance selections with the same rank have the same
-            # preference.
-      },
-    },
-    "instanceSelections": { # Named instance selections configuring properties that the group will use
-        # when creating new VMs.
-      "a_key": {
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
+        "rank": 42, # Preference of this instance selection. Lower number means higher
+            # preference. MIG will first try to create a VM based on the machine-type
+            # with lowest rank and fallback to next rank based on availability.
+            # Machine types and instance selections with the same rank have the same
+            # preference.
+      },
+    },
+    "instanceSelections": { # Named instance selections configuring properties that the group will use
+        # when creating new VMs.
+      "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -3036,6 +4998,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -4029,22 +5997,1000 @@ 
Method Details

         "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
             # when creating new VMs.
           "a_key": {
+            "disks": [ # List of disks to be attached to the instances created from this
+                # selection.
+              { # An instance-attached disk resource.
+                "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                    # or X86_64.
+                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                    # deleted (but not when the disk is detached from the instance).
+                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                    # partition of the disk for its root filesystem.
+                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                    # running within the instance. This name can be used to reference the device
+                    # for mounting, resizing, and so on, from within the instance.
+                    #
+                    # If not specified, the server chooses a default device name to apply to this
+                    # disk, in the form persistent-disk-x, where x is a number
+                    # assigned by Google Compute Engine. This field is only applicable for
+                    # persistent disks.
+                "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                    # encryption key.
+                    #
+                    # If you are creating a new disk, this field encrypts the new disk using
+                    # an encryption key that you provide. If you are attaching an existing
+                    # disk that is already encrypted, this field decrypts the disk using
+                    # the customer-supplied encryption key.
+                    #
+                    # If you encrypt a disk using a customer-supplied key, you must provide the
+                    # same key again when you attempt to use this resource at a later time. For
+                    # example, you must provide the key when you create a snapshot or an image
+                    # from the disk or when you attach the disk to a virtual machine instance.
+                    #
+                    # If you do not provide an encryption key, then the disk will be encrypted
+                    # using an automatically generated key and you do not need to provide a key
+                    # to use the disk later.
+                    #
+                    # Note:
+                    #
+                    # Instance templates do not storecustomer-supplied
+                    # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                    #
+                    # You cannot create VMs that have disks with customer-supplied keys using
+                    # the bulk
+                    # insert method.
+                  "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                      # For example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      #
+                      # The fully-qualifed key name may be returned for resource GET requests. For
+                      # example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      # /cryptoKeyVersions/1
+                  "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                      # key. If absent, the Compute Engine default service account is used.
+                      # For example:
+                      #
+                      # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                  "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                      # encryption key, encoded in RFC
+                      # 4648 base64 to either encrypt or decrypt this resource. You can
+                      # provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rawKey":
+                      # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                      # customer-supplied encryption key to either encrypt or decrypt this
+                      # resource. You can provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rsaEncryptedKey":
+                      # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                      # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                      # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                      #
+                      # The key must meet the following requirements before you can provide it to
+                      # Compute Engine:
+                      #
+                      #    1. The key is wrapped using a RSA public key certificate provided by
+                      #    Google.
+                      #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                      #    encoding.
+                      #
+                      # Gets the RSA public key certificate provided by Google at:
+                      #
+                      #
+                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                  "sha256": "A String", # [Output only] TheRFC
+                      # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                      # encryption key that protects this resource.
+                },
+                "diskSizeGb": "A String", # The size of the disk in GB.
+                "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                    # currently attached to another instance. If you try to force attach a zonal
+                    # disk to an instance, you will receive an error.
+                "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                    # only for bootable images. Read
+                    # Enabling guest operating system features to see a list of available
+                    # options.
+                  { # Guest OS features.
+                    "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                        # separate values. Set to one or more of the following values:
+                        #
+                        #    - VIRTIO_SCSI_MULTIQUEUE
+                        #    - WINDOWS
+                        #    - MULTI_IP_SUBNET
+                        #    - UEFI_COMPATIBLE
+                        #    - GVNIC
+                        #    - SEV_CAPABLE
+                        #    - SUSPEND_RESUME_COMPATIBLE
+                        #    - SEV_LIVE_MIGRATABLE_V2
+                        #    - SEV_SNP_CAPABLE
+                        #    - TDX_CAPABLE
+                        #    - IDPF
+                        #    - SNP_SVSM_CAPABLE
+                        #
+                        #
+                        # For more information, see
+                        # Enabling guest operating system features.
+                  },
+                ],
+                "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                    # boot disk. If you have many disks attached to an instance, each
+                    # disk would have a unique index number.
+                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This field is persisted and returned for instanceTemplate and not returned
+                    # in the context of instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                  "architecture": "A String", # The architecture of the attached disk. Valid values are
+                      # arm64 or x86_64.
+                  "description": "A String", # An optional description. Provide this property when creating the disk.
+                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                      # of the instance. If a disk with the same name already exists in the given
+                      # region, the existing disk is attached to the new instance and the
+                      # new disk is not created.
+                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                      # 10 GB. If you specify a sourceImage, which is required for
+                      # boot disks, the default size is the size of the sourceImage.
+                      # If you do not specify a sourceImage, the default disk size
+                      # is 500 GB.
+                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                      # the default is pd-standard, specified using the full URL.
+                      # For example:
+                      #
+                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                      #
+                      #
+                      # For a full list of acceptable values, seePersistent disk
+                      # types. If you specify this field when creating a VM, you can provide
+                      # either the full or partial URL. For example, the following values are
+                      # valid:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                      #    - projects/project/zones/zone/diskTypes/diskType
+                      #    - zones/zone/diskTypes/diskType
+                      #
+                      #
+                      # If you specify this field when creating or updating an instance template
+                      # or all-instances configuration, specify the type of the disk, not the
+                      # URL. For example: pd-standard.
+                  "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+                  "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                      # only for bootable images. Read
+                      # Enabling guest operating system features to see a list of available
+                      # options.
+                      #
+                      # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                    { # Guest OS features.
+                      "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                          # separate values. Set to one or more of the following values:
+                          #
+                          #    - VIRTIO_SCSI_MULTIQUEUE
+                          #    - WINDOWS
+                          #    - MULTI_IP_SUBNET
+                          #    - UEFI_COMPATIBLE
+                          #    - GVNIC
+                          #    - SEV_CAPABLE
+                          #    - SUSPEND_RESUME_COMPATIBLE
+                          #    - SEV_LIVE_MIGRATABLE_V2
+                          #    - SEV_SNP_CAPABLE
+                          #    - TDX_CAPABLE
+                          #    - IDPF
+                          #    - SNP_SVSM_CAPABLE
+                          #
+                          #
+                          # For more information, see
+                          # Enabling guest operating system features.
+                    },
+                  ],
+                  "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                      # which is either SCSI or NVME. The default isSCSI.
+                  "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                      # persistent disks.
+                    "a_key": "A String",
+                  },
+                  "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                      # disk.
+                    "A String",
+                  ],
+                  "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                    "A String",
+                  ],
+                  "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                      # more than one instance.
+                  "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                      # is to use the existing disk.
+                  "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                      # of I/O operations per second that the disk can handle. Values must be
+                      # between 10,000 and 120,000. For more details, see theExtreme persistent
+                      # disk documentation.
+                  "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                      # number of throughput mb per second that the disk can handle. Values must
+                      # greater than or equal to 1.
+                  "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                      # the URLs of the zones where the disk should be replicated to.
+                      # You must provide exactly two replica zones, and one zone must be the same
+                      # as the instance zone.
+                    "A String",
+                  ],
+                  "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                      # have the same definition as resource
+                      # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                      # values are in the format `tagValues/456`. The field is ignored (both PUT
+                      # & PATCH) when empty.
+                    "a_key": "A String",
+                  },
+                  "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                      # Specified using the full or partial URL. For instance template, specify
+                      # only the resource policy name.
+                    "A String",
+                  ],
+                  "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                      # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                      # is required.
+                      #
+                      # To create a disk with one of the public operating system
+                      # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                      #
+                      # projects/debian-cloud/global/images/family/debian-9
+                      #
+                      #
+                      # Alternatively, use a specific version of a public operating system image:
+                      #
+                      # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                      #
+                      #
+                      # To create a disk with a custom image that you created, specify the
+                      # image name in the following format:
+                      #
+                      # global/images/my-custom-image
+                      #
+                      #
+                      # You can also specify a custom image by its image family, which returns
+                      # the latest version of the image in that family. Replace the image name
+                      # with family/family-name:
+                      #
+                      # global/images/family/my-image-family
+                      #
+                      #
+                      # If the source image is deleted later, this field will not be set.
+                  "sourceImageEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source image. Required if the source image is
+                      # protected by a customer-supplied encryption key.
+                      #
+                      # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                      # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                      # source images are encrypted with your own keys.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                      # instance boot disk, one of initializeParams.sourceSnapshot
+                      # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # us-central1-a/instantSnapshots/my-backup
+                      #
+                      #
+                      # If the source instant-snapshot is deleted later, this field will not be
+                      # set.
+                  "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                      # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # global/snapshots/my-backup
+                      #
+                      #
+                      # If the source snapshot is deleted later, this field will not be set.
+                      #
+                      # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                      # an image instead when you create VMs using
+                      # the bulk
+                      # insert method.
+                  "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source snapshot.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                      # this as a partial or full URL to the resource. For example, the following
+                      # are valid values:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                      #      - projects/project/zones/zone/storagePools/storagePool
+                      #    - zones/zone/storagePools/storagePool
+                },
+                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                    # either SCSI or NVME. For most machine types, the
+                    # default is SCSI. Local SSDs can use either NVME or SCSI.
+                    # In certain configurations, persistent disks can use NVMe. For more
+                    # information, seeAbout
+                    # persistent disks.
+                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+                "licenses": [ # [Output Only] Any valid publicly visible licenses.
+                  "A String",
+                ],
+                "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                    # disk is not allowed to be detached from the instance, or to be used as the
+                    # source of the snapshot creation, and the image creation. The instance with
+                    # at least one locked attached disk is not allow to be used as source of
+                    # machine image creation, instant snapshot creation, and not allowed to be
+                    # deleted with --keep-disk parameter set to true for locked disks.
+                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                    # in READ_WRITE mode.
+                "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                    # field is set to PRESERVED if the LocalSSD data has been saved
+                    # to a persistent location by customer request.  (see the
+                    # discard_local_ssd option on Stop/Suspend).
+                    # Read-only in the api.
+                "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                    # these are public keys which are safe to store in public
+                  "dbs": [ # The Key Database (db).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "dbxs": [ # The forbidden key database (dbx).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "keks": [ # The Key Exchange Key (KEK).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "pk": { # The Platform Key (PK).
+                    "content": "A String", # The raw content in the secure keys file.
+                    "fileType": "A String", # The file type of source file.
+                  },
+                },
+                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                    # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                    # is required.
+                    #
+                    # If desired, you can also attach existing non-root persistent disks using
+                    # this property. This field is only applicable for persistent disks.
+                    #
+                    # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                    # and the URL for regional disk.
+                "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+                "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                    # URLs to the license resource. Unlike regular licenses, user provided
+                    # licenses can be modified after the disk is created.
+                  "A String",
+                ],
+              },
+            ],
             "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
               "A String",
             ],
-            "rank": 42, # Preference of this instance selection. Lower number means higher
-                # preference. MIG will first try to create a VM based on the machine-type
-                # with lowest rank and fallback to next rank based on availability.
-                # Machine types and instance selections with the same rank have the same
-                # preference.
-          },
-        },
-        "instanceSelections": { # Named instance selections configuring properties that the group will use
-            # when creating new VMs.
-          "a_key": {
+            "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+                # e.g. 'Intel Ice Lake'.
+            "rank": 42, # Preference of this instance selection. Lower number means higher
+                # preference. MIG will first try to create a VM based on the machine-type
+                # with lowest rank and fallback to next rank based on availability.
+                # Machine types and instance selections with the same rank have the same
+                # preference.
+          },
+        },
+        "instanceSelections": { # Named instance selections configuring properties that the group will use
+            # when creating new VMs.
+          "a_key": {
+            "disks": [ # List of disks to be attached to the instances created from this
+                # selection.
+              { # An instance-attached disk resource.
+                "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                    # or X86_64.
+                "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                    # deleted (but not when the disk is detached from the instance).
+                "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                    # partition of the disk for its root filesystem.
+                "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                    # running within the instance. This name can be used to reference the device
+                    # for mounting, resizing, and so on, from within the instance.
+                    #
+                    # If not specified, the server chooses a default device name to apply to this
+                    # disk, in the form persistent-disk-x, where x is a number
+                    # assigned by Google Compute Engine. This field is only applicable for
+                    # persistent disks.
+                "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                    # encryption key.
+                    #
+                    # If you are creating a new disk, this field encrypts the new disk using
+                    # an encryption key that you provide. If you are attaching an existing
+                    # disk that is already encrypted, this field decrypts the disk using
+                    # the customer-supplied encryption key.
+                    #
+                    # If you encrypt a disk using a customer-supplied key, you must provide the
+                    # same key again when you attempt to use this resource at a later time. For
+                    # example, you must provide the key when you create a snapshot or an image
+                    # from the disk or when you attach the disk to a virtual machine instance.
+                    #
+                    # If you do not provide an encryption key, then the disk will be encrypted
+                    # using an automatically generated key and you do not need to provide a key
+                    # to use the disk later.
+                    #
+                    # Note:
+                    #
+                    # Instance templates do not storecustomer-supplied
+                    # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                    #
+                    # You cannot create VMs that have disks with customer-supplied keys using
+                    # the bulk
+                    # insert method.
+                  "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                      # For example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      #
+                      # The fully-qualifed key name may be returned for resource GET requests. For
+                      # example:
+                      #
+                      # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                      # key_region/cryptoKeys/key
+                      # /cryptoKeyVersions/1
+                  "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                      # key. If absent, the Compute Engine default service account is used.
+                      # For example:
+                      #
+                      # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                  "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                      # encryption key, encoded in RFC
+                      # 4648 base64 to either encrypt or decrypt this resource. You can
+                      # provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rawKey":
+                      # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                  "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                      # customer-supplied encryption key to either encrypt or decrypt this
+                      # resource. You can provide either the rawKey or thersaEncryptedKey.
+                      # For example:
+                      #
+                      # "rsaEncryptedKey":
+                      # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                      # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                      # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                      #
+                      # The key must meet the following requirements before you can provide it to
+                      # Compute Engine:
+                      #
+                      #    1. The key is wrapped using a RSA public key certificate provided by
+                      #    Google.
+                      #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                      #    encoding.
+                      #
+                      # Gets the RSA public key certificate provided by Google at:
+                      #
+                      #
+                      # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                  "sha256": "A String", # [Output only] TheRFC
+                      # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                      # encryption key that protects this resource.
+                },
+                "diskSizeGb": "A String", # The size of the disk in GB.
+                "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                    # currently attached to another instance. If you try to force attach a zonal
+                    # disk to an instance, you will receive an error.
+                "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                    # only for bootable images. Read
+                    # Enabling guest operating system features to see a list of available
+                    # options.
+                  { # Guest OS features.
+                    "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                        # separate values. Set to one or more of the following values:
+                        #
+                        #    - VIRTIO_SCSI_MULTIQUEUE
+                        #    - WINDOWS
+                        #    - MULTI_IP_SUBNET
+                        #    - UEFI_COMPATIBLE
+                        #    - GVNIC
+                        #    - SEV_CAPABLE
+                        #    - SUSPEND_RESUME_COMPATIBLE
+                        #    - SEV_LIVE_MIGRATABLE_V2
+                        #    - SEV_SNP_CAPABLE
+                        #    - TDX_CAPABLE
+                        #    - IDPF
+                        #    - SNP_SVSM_CAPABLE
+                        #
+                        #
+                        # For more information, see
+                        # Enabling guest operating system features.
+                  },
+                ],
+                "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                    # boot disk. If you have many disks attached to an instance, each
+                    # disk would have a unique index number.
+                "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                    # alongside the new instance. Use initialization parameters to create boot
+                    # disks or local SSDs attached to the new instance.
+                    #
+                    # This field is persisted and returned for instanceTemplate and not returned
+                    # in the context of instance.
+                    #
+                    # This property is mutually exclusive with the source property;
+                    # you can only define one or the other, but not both.
+                  "architecture": "A String", # The architecture of the attached disk. Valid values are
+                      # arm64 or x86_64.
+                  "description": "A String", # An optional description. Provide this property when creating the disk.
+                  "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                      # of the instance. If a disk with the same name already exists in the given
+                      # region, the existing disk is attached to the new instance and the
+                      # new disk is not created.
+                  "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                      # 10 GB. If you specify a sourceImage, which is required for
+                      # boot disks, the default size is the size of the sourceImage.
+                      # If you do not specify a sourceImage, the default disk size
+                      # is 500 GB.
+                  "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                      # the default is pd-standard, specified using the full URL.
+                      # For example:
+                      #
+                      # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                      #
+                      #
+                      # For a full list of acceptable values, seePersistent disk
+                      # types. If you specify this field when creating a VM, you can provide
+                      # either the full or partial URL. For example, the following values are
+                      # valid:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                      #    - projects/project/zones/zone/diskTypes/diskType
+                      #    - zones/zone/diskTypes/diskType
+                      #
+                      #
+                      # If you specify this field when creating or updating an instance template
+                      # or all-instances configuration, specify the type of the disk, not the
+                      # URL. For example: pd-standard.
+                  "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+                  "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                      # only for bootable images. Read
+                      # Enabling guest operating system features to see a list of available
+                      # options.
+                      #
+                      # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                    { # Guest OS features.
+                      "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                          # separate values. Set to one or more of the following values:
+                          #
+                          #    - VIRTIO_SCSI_MULTIQUEUE
+                          #    - WINDOWS
+                          #    - MULTI_IP_SUBNET
+                          #    - UEFI_COMPATIBLE
+                          #    - GVNIC
+                          #    - SEV_CAPABLE
+                          #    - SUSPEND_RESUME_COMPATIBLE
+                          #    - SEV_LIVE_MIGRATABLE_V2
+                          #    - SEV_SNP_CAPABLE
+                          #    - TDX_CAPABLE
+                          #    - IDPF
+                          #    - SNP_SVSM_CAPABLE
+                          #
+                          #
+                          # For more information, see
+                          # Enabling guest operating system features.
+                    },
+                  ],
+                  "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                      # which is either SCSI or NVME. The default isSCSI.
+                  "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                      # persistent disks.
+                    "a_key": "A String",
+                  },
+                  "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                      # disk.
+                    "A String",
+                  ],
+                  "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                    "A String",
+                  ],
+                  "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                      # more than one instance.
+                  "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                      # is to use the existing disk.
+                  "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                      # of I/O operations per second that the disk can handle. Values must be
+                      # between 10,000 and 120,000. For more details, see theExtreme persistent
+                      # disk documentation.
+                  "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                      # number of throughput mb per second that the disk can handle. Values must
+                      # greater than or equal to 1.
+                  "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                      # the URLs of the zones where the disk should be replicated to.
+                      # You must provide exactly two replica zones, and one zone must be the same
+                      # as the instance zone.
+                    "A String",
+                  ],
+                  "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                      # have the same definition as resource
+                      # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                      # values are in the format `tagValues/456`. The field is ignored (both PUT
+                      # & PATCH) when empty.
+                    "a_key": "A String",
+                  },
+                  "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                      # Specified using the full or partial URL. For instance template, specify
+                      # only the resource policy name.
+                    "A String",
+                  ],
+                  "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                      # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                      # is required.
+                      #
+                      # To create a disk with one of the public operating system
+                      # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                      #
+                      # projects/debian-cloud/global/images/family/debian-9
+                      #
+                      #
+                      # Alternatively, use a specific version of a public operating system image:
+                      #
+                      # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                      #
+                      #
+                      # To create a disk with a custom image that you created, specify the
+                      # image name in the following format:
+                      #
+                      # global/images/my-custom-image
+                      #
+                      #
+                      # You can also specify a custom image by its image family, which returns
+                      # the latest version of the image in that family. Replace the image name
+                      # with family/family-name:
+                      #
+                      # global/images/family/my-image-family
+                      #
+                      #
+                      # If the source image is deleted later, this field will not be set.
+                  "sourceImageEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source image. Required if the source image is
+                      # protected by a customer-supplied encryption key.
+                      #
+                      # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                      # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                      # source images are encrypted with your own keys.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                      # instance boot disk, one of initializeParams.sourceSnapshot
+                      # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # us-central1-a/instantSnapshots/my-backup
+                      #
+                      #
+                      # If the source instant-snapshot is deleted later, this field will not be
+                      # set.
+                  "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                      # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                      # is required.
+                      #
+                      # To create a disk with a snapshot that you created, specify the
+                      # snapshot name in the following format:
+                      #
+                      # global/snapshots/my-backup
+                      #
+                      #
+                      # If the source snapshot is deleted later, this field will not be set.
+                      #
+                      # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                      # an image instead when you create VMs using
+                      # the bulk
+                      # insert method.
+                  "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                      # encryption key of the source snapshot.
+                    "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                        # For example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        #
+                        # The fully-qualifed key name may be returned for resource GET requests. For
+                        # example:
+                        #
+                        # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                        # key_region/cryptoKeys/key
+                        # /cryptoKeyVersions/1
+                    "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                        # key. If absent, the Compute Engine default service account is used.
+                        # For example:
+                        #
+                        # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                    "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                        # encryption key, encoded in RFC
+                        # 4648 base64 to either encrypt or decrypt this resource. You can
+                        # provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rawKey":
+                        # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                    "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                        # customer-supplied encryption key to either encrypt or decrypt this
+                        # resource. You can provide either the rawKey or thersaEncryptedKey.
+                        # For example:
+                        #
+                        # "rsaEncryptedKey":
+                        # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                        # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                        # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                        #
+                        # The key must meet the following requirements before you can provide it to
+                        # Compute Engine:
+                        #
+                        #    1. The key is wrapped using a RSA public key certificate provided by
+                        #    Google.
+                        #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                        #    encoding.
+                        #
+                        # Gets the RSA public key certificate provided by Google at:
+                        #
+                        #
+                        # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                    "sha256": "A String", # [Output only] TheRFC
+                        # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                        # encryption key that protects this resource.
+                  },
+                  "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                      # this as a partial or full URL to the resource. For example, the following
+                      # are valid values:
+                      #
+                      #
+                      #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                      #      - projects/project/zones/zone/storagePools/storagePool
+                      #    - zones/zone/storagePools/storagePool
+                },
+                "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                    # either SCSI or NVME. For most machine types, the
+                    # default is SCSI. Local SSDs can use either NVME or SCSI.
+                    # In certain configurations, persistent disks can use NVMe. For more
+                    # information, seeAbout
+                    # persistent disks.
+                "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+                "licenses": [ # [Output Only] Any valid publicly visible licenses.
+                  "A String",
+                ],
+                "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                    # disk is not allowed to be detached from the instance, or to be used as the
+                    # source of the snapshot creation, and the image creation. The instance with
+                    # at least one locked attached disk is not allow to be used as source of
+                    # machine image creation, instant snapshot creation, and not allowed to be
+                    # deleted with --keep-disk parameter set to true for locked disks.
+                "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                    # in READ_WRITE mode.
+                "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                    # field is set to PRESERVED if the LocalSSD data has been saved
+                    # to a persistent location by customer request.  (see the
+                    # discard_local_ssd option on Stop/Suspend).
+                    # Read-only in the api.
+                "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                    # these are public keys which are safe to store in public
+                  "dbs": [ # The Key Database (db).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "dbxs": [ # The forbidden key database (dbx).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "keks": [ # The Key Exchange Key (KEK).
+                    {
+                      "content": "A String", # The raw content in the secure keys file.
+                      "fileType": "A String", # The file type of source file.
+                    },
+                  ],
+                  "pk": { # The Platform Key (PK).
+                    "content": "A String", # The raw content in the secure keys file.
+                    "fileType": "A String", # The file type of source file.
+                  },
+                },
+                "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                    # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                    # is required.
+                    #
+                    # If desired, you can also attach existing non-root persistent disks using
+                    # this property. This field is only applicable for persistent disks.
+                    #
+                    # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                    # and the URL for regional disk.
+                "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+                "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                    # URLs to the license resource. Unlike regular licenses, user provided
+                    # licenses can be modified after the disk is created.
+                  "A String",
+                ],
+              },
+            ],
             "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
               "A String",
             ],
+            "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+                # e.g. 'Intel Ice Lake'.
             "rank": 42, # Preference of this instance selection. Lower number means higher
                 # preference. MIG will first try to create a VM based on the machine-type
                 # with lowest rank and fallback to next rank based on availability.
@@ -4112,6 +7058,12 @@ 
Method Details

             #    About repairing VMs in a MIG.
         "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
           "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+              # Valid values are:
+              #
+              #    - NO (default): MIG cannot change a VM's zone during a
+              #    repair.
+              #    - YES: MIG can select a different zone for the VM during
+              #    a repair.
         },
       },
       "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -4912,7 +7864,495 @@ 
Method Details

           # instance has not yet been created.
       "instanceFlexibilityOverride": { # [Output Only] The overrides to instance properties resulting from
           # InstanceFlexibilityPolicy.
+        "disks": [ # List of disks to be attached to the instance.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineType": "A String", # The machine type to be used for this instance.
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance.
+            # e.g. 'Intel Ice Lake'.
         "provisioningModel": "A String", # The provisioning model to be used for this instance.
       },
       "instanceHealth": [ # [Output Only] Health state of the instance per health-check.
@@ -5616,22 +9056,1000 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
-        "rank": 42, # Preference of this instance selection. Lower number means higher
-            # preference. MIG will first try to create a VM based on the machine-type
-            # with lowest rank and fallback to next rank based on availability.
-            # Machine types and instance selections with the same rank have the same
-            # preference.
-      },
-    },
-    "instanceSelections": { # Named instance selections configuring properties that the group will use
-        # when creating new VMs.
-      "a_key": {
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
+        "rank": 42, # Preference of this instance selection. Lower number means higher
+            # preference. MIG will first try to create a VM based on the machine-type
+            # with lowest rank and fallback to next rank based on availability.
+            # Machine types and instance selections with the same rank have the same
+            # preference.
+      },
+    },
+    "instanceSelections": { # Named instance selections configuring properties that the group will use
+        # when creating new VMs.
+      "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -5699,6 +10117,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -10117,9 +14541,498 @@ 
Method Details

     "instanceSelectionLists": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -10130,9 +15043,498 @@ 
Method Details

     "instanceSelections": { # Named instance selections configuring properties that the group will use
         # when creating new VMs.
       "a_key": {
+        "disks": [ # List of disks to be attached to the instances created from this
+            # selection.
+          { # An instance-attached disk resource.
+            "architecture": "A String", # [Output Only] The architecture of the attached disk. Valid values are ARM64
+                # or X86_64.
+            "autoDelete": True or False, # Specifies whether the disk will be auto-deleted when the instance is
+                # deleted (but not when the disk is detached from the instance).
+            "boot": True or False, # Indicates that this is a boot disk. The virtual machine will use the first
+                # partition of the disk for its root filesystem.
+            "deviceName": "A String", # Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
+                # running within the instance. This name can be used to reference the device
+                # for mounting, resizing, and so on, from within the instance.
+                #
+                # If not specified, the server chooses a default device name to apply to this
+                # disk, in the form persistent-disk-x, where x is a number
+                # assigned by Google Compute Engine. This field is only applicable for
+                # persistent disks.
+            "diskEncryptionKey": { # Encrypts or decrypts a disk using acustomer-supplied
+                # encryption key.
+                #
+                # If you are creating a new disk, this field encrypts the new disk using
+                # an encryption key that you provide. If you are attaching an existing
+                # disk that is already encrypted, this field decrypts the disk using
+                # the customer-supplied encryption key.
+                #
+                # If you encrypt a disk using a customer-supplied key, you must provide the
+                # same key again when you attempt to use this resource at a later time. For
+                # example, you must provide the key when you create a snapshot or an image
+                # from the disk or when you attach the disk to a virtual machine instance.
+                #
+                # If you do not provide an encryption key, then the disk will be encrypted
+                # using an automatically generated key and you do not need to provide a key
+                # to use the disk later.
+                #
+                # Note:
+                #
+                # Instance templates do not storecustomer-supplied
+                # encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.
+                #
+                # You cannot create VMs that have disks with customer-supplied keys using
+                # the bulk
+                # insert method.
+              "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                  # For example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  #
+                  # The fully-qualifed key name may be returned for resource GET requests. For
+                  # example:
+                  #
+                  # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                  # key_region/cryptoKeys/key
+                  # /cryptoKeyVersions/1
+              "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                  # key. If absent, the Compute Engine default service account is used.
+                  # For example:
+                  #
+                  # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+              "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                  # encryption key, encoded in RFC
+                  # 4648 base64 to either encrypt or decrypt this resource. You can
+                  # provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rawKey":
+                  # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+              "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                  # customer-supplied encryption key to either encrypt or decrypt this
+                  # resource. You can provide either the rawKey or thersaEncryptedKey.
+                  # For example:
+                  #
+                  # "rsaEncryptedKey":
+                  # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                  # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                  # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                  #
+                  # The key must meet the following requirements before you can provide it to
+                  # Compute Engine:
+                  #
+                  #    1. The key is wrapped using a RSA public key certificate provided by
+                  #    Google.
+                  #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                  #    encoding.
+                  #
+                  # Gets the RSA public key certificate provided by Google at:
+                  #
+                  #
+                  # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+              "sha256": "A String", # [Output only] TheRFC
+                  # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                  # encryption key that protects this resource.
+            },
+            "diskSizeGb": "A String", # The size of the disk in GB.
+            "forceAttach": True or False, # [Input Only] Whether to force attach the regional disk even if it's
+                # currently attached to another instance. If you try to force attach a zonal
+                # disk to an instance, you will receive an error.
+            "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                # only for bootable images. Read
+                # Enabling guest operating system features to see a list of available
+                # options.
+              { # Guest OS features.
+                "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                    # separate values. Set to one or more of the following values:
+                    #
+                    #    - VIRTIO_SCSI_MULTIQUEUE
+                    #    - WINDOWS
+                    #    - MULTI_IP_SUBNET
+                    #    - UEFI_COMPATIBLE
+                    #    - GVNIC
+                    #    - SEV_CAPABLE
+                    #    - SUSPEND_RESUME_COMPATIBLE
+                    #    - SEV_LIVE_MIGRATABLE_V2
+                    #    - SEV_SNP_CAPABLE
+                    #    - TDX_CAPABLE
+                    #    - IDPF
+                    #    - SNP_SVSM_CAPABLE
+                    #
+                    #
+                    # For more information, see
+                    # Enabling guest operating system features.
+              },
+            ],
+            "index": 42, # [Output Only] A zero-based index to this disk, where 0 is reserved for the
+                # boot disk. If you have many disks attached to an instance, each
+                # disk would have a unique index number.
+            "initializeParams": { # [Input Only] Specifies the parameters for a new disk that will be created # [Input Only] Specifies the parameters for a new disk that will be created
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+                # alongside the new instance. Use initialization parameters to create boot
+                # disks or local SSDs attached to the new instance.
+                #
+                # This field is persisted and returned for instanceTemplate and not returned
+                # in the context of instance.
+                #
+                # This property is mutually exclusive with the source property;
+                # you can only define one or the other, but not both.
+              "architecture": "A String", # The architecture of the attached disk. Valid values are
+                  # arm64 or x86_64.
+              "description": "A String", # An optional description. Provide this property when creating the disk.
+              "diskName": "A String", # Specifies the disk name. If not specified, the default is to use the name
+                  # of the instance. If a disk with the same name already exists in the given
+                  # region, the existing disk is attached to the new instance and the
+                  # new disk is not created.
+              "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. The size must be at least
+                  # 10 GB. If you specify a sourceImage, which is required for
+                  # boot disks, the default size is the size of the sourceImage.
+                  # If you do not specify a sourceImage, the default disk size
+                  # is 500 GB.
+              "diskType": "A String", # Specifies the disk type to use to create the instance. If not specified,
+                  # the default is pd-standard, specified using the full URL.
+                  # For example:
+                  #
+                  # https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard
+                  #
+                  #
+                  # For a full list of acceptable values, seePersistent disk
+                  # types. If you specify this field when creating a VM, you can provide
+                  # either the full or partial URL. For example, the following values are
+                  # valid:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
+                  #    - projects/project/zones/zone/diskTypes/diskType
+                  #    - zones/zone/diskTypes/diskType
+                  #
+                  #
+                  # If you specify this field when creating or updating an instance template
+                  # or all-instances configuration, specify the type of the disk, not the
+                  # URL. For example: pd-standard.
+              "enableConfidentialCompute": True or False, # Whether this disk is using confidential compute mode.
+              "guestOsFeatures": [ # A list of features to enable on the guest operating system. Applicable
+                  # only for bootable images. Read
+                  # Enabling guest operating system features to see a list of available
+                  # options.
+                  #
+                  # Guest OS features are applied by merginginitializeParams.guestOsFeatures anddisks.guestOsFeatures
+                { # Guest OS features.
+                  "type": "A String", # The ID of a supported feature. To add multiple values, use commas to
+                      # separate values. Set to one or more of the following values:
+                      #
+                      #    - VIRTIO_SCSI_MULTIQUEUE
+                      #    - WINDOWS
+                      #    - MULTI_IP_SUBNET
+                      #    - UEFI_COMPATIBLE
+                      #    - GVNIC
+                      #    - SEV_CAPABLE
+                      #    - SUSPEND_RESUME_COMPATIBLE
+                      #    - SEV_LIVE_MIGRATABLE_V2
+                      #    - SEV_SNP_CAPABLE
+                      #    - TDX_CAPABLE
+                      #    - IDPF
+                      #    - SNP_SVSM_CAPABLE
+                      #
+                      #
+                      # For more information, see
+                      # Enabling guest operating system features.
+                },
+              ],
+              "interface": "A String", # [Deprecated] Specifies the disk interface to use for attaching this disk,
+                  # which is either SCSI or NVME. The default isSCSI.
+              "labels": { # Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for
+                  # persistent disks.
+                "a_key": "A String",
+              },
+              "licenseCodes": [ # Integer license codes indicating which licenses are attached to this
+                  # disk.
+                "A String",
+              ],
+              "licenses": [ # A list of publicly visible licenses. Reserved for Google's use.
+                "A String",
+              ],
+              "multiWriter": True or False, # Indicates whether or not the disk can be read/write attached to
+                  # more than one instance.
+              "onUpdateAction": "A String", # Specifies which action to take on instance update with this disk. Default
+                  # is to use the existing disk.
+              "provisionedIops": "A String", # Indicates how many IOPS to provision for the disk. This sets the number
+                  # of I/O operations per second that the disk can handle. Values must be
+                  # between 10,000 and 120,000. For more details, see theExtreme persistent
+                  # disk documentation.
+              "provisionedThroughput": "A String", # Indicates how much throughput to provision for the disk. This sets the
+                  # number of throughput mb per second that the disk can handle. Values must
+                  # greater than or equal to 1.
+              "replicaZones": [ # Required for each regional disk associated with the instance. Specify
+                  # the URLs of the zones where the disk should be replicated to.
+                  # You must provide exactly two replica zones, and one zone must be the same
+                  # as the instance zone.
+                "A String",
+              ],
+              "resourceManagerTags": { # Resource manager tags to be bound to the disk. Tag keys and values
+                  # have the same definition as resource
+                  # manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and
+                  # values are in the format `tagValues/456`. The field is ignored (both PUT
+                  # & PATCH) when empty.
+                "a_key": "A String",
+              },
+              "resourcePolicies": [ # Resource policies applied to this disk for automatic snapshot creations.
+                  # Specified using the full or partial URL. For instance template, specify
+                  # only the resource policy name.
+                "A String",
+              ],
+              "sourceImage": "A String", # The source image to create this disk. When creating a new instance boot
+                  # disk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                  # is required.
+                  #
+                  # To create a disk with one of the public operating system
+                  # images, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:
+                  #
+                  # projects/debian-cloud/global/images/family/debian-9
+                  #
+                  #
+                  # Alternatively, use a specific version of a public operating system image:
+                  #
+                  # projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD
+                  #
+                  #
+                  # To create a disk with a custom image that you created, specify the
+                  # image name in the following format:
+                  #
+                  # global/images/my-custom-image
+                  #
+                  #
+                  # You can also specify a custom image by its image family, which returns
+                  # the latest version of the image in that family. Replace the image name
+                  # with family/family-name:
+                  #
+                  # global/images/family/my-image-family
+                  #
+                  #
+                  # If the source image is deleted later, this field will not be set.
+              "sourceImageEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source image. Required if the source image is
+                  # protected by a customer-supplied encryption key.
+                  #
+                  # InstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied
+                  # encryption keys, so you cannot create disks for instances in a managed instance group if the
+                  # source images are encrypted with your own keys.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "sourceInstantSnapshot": "A String", # The source instant-snapshot to create this disk. When creating a new
+                  # instance boot disk, one of initializeParams.sourceSnapshot
+                  # or initializeParams.sourceInstantSnapshotinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # us-central1-a/instantSnapshots/my-backup
+                  #
+                  #
+                  # If the source instant-snapshot is deleted later, this field will not be
+                  # set.
+              "sourceSnapshot": "A String", # The source snapshot to create this disk. When creating a new instance
+                  # boot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source
+                  # is required.
+                  #
+                  # To create a disk with a snapshot that you created, specify the
+                  # snapshot name in the following format:
+                  #
+                  # global/snapshots/my-backup
+                  #
+                  #
+                  # If the source snapshot is deleted later, this field will not be set.
+                  #
+                  # Note: You cannot create VMs in bulk using a snapshot as the source. Use
+                  # an image instead when you create VMs using
+                  # the bulk
+                  # insert method.
+              "sourceSnapshotEncryptionKey": { # Thecustomer-supplied
+                  # encryption key of the source snapshot.
+                "kmsKeyName": "A String", # The name of the encryption key that is stored in Google Cloud KMS.
+                    # For example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    #
+                    # The fully-qualifed key name may be returned for resource GET requests. For
+                    # example:
+                    #
+                    # "kmsKeyName": "projects/kms_project_id/locations/region/keyRings/
+                    # key_region/cryptoKeys/key
+                    # /cryptoKeyVersions/1
+                "kmsKeyServiceAccount": "A String", # The service account being used for the encryption request for the given KMS
+                    # key. If absent, the Compute Engine default service account is used.
+                    # For example:
+                    #
+                    # "kmsKeyServiceAccount": "name@project_id.iam.gserviceaccount.com/
+                "rawKey": "A String", # Specifies a 256-bit customer-supplied
+                    # encryption key, encoded in RFC
+                    # 4648 base64 to either encrypt or decrypt this resource. You can
+                    # provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rawKey":
+                    # "SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
+                "rsaEncryptedKey": "A String", # Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit
+                    # customer-supplied encryption key to either encrypt or decrypt this
+                    # resource. You can provide either the rawKey or thersaEncryptedKey.
+                    # For example:
+                    #
+                    # "rsaEncryptedKey":
+                    # "ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH
+                    # z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD
+                    # D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe=="
+                    #
+                    # The key must meet the following requirements before you can provide it to
+                    # Compute Engine:
+                    #
+                    #    1. The key is wrapped using a RSA public key certificate provided by
+                    #    Google.
+                    #    2. After being wrapped, the key must be encoded in RFC 4648 base64
+                    #    encoding.
+                    #
+                    # Gets the RSA public key certificate provided by Google at:
+                    #
+                    #
+                    # https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
+                "sha256": "A String", # [Output only] TheRFC
+                    # 4648 base64 encoded SHA-256 hash of the customer-supplied
+                    # encryption key that protects this resource.
+              },
+              "storagePool": "A String", # The storage pool in which the new disk is created. You can provide
+                  # this as a partial or full URL to the resource. For example, the following
+                  # are valid values:
+                  #
+                  #
+                  #      - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool
+                  #      - projects/project/zones/zone/storagePools/storagePool
+                  #    - zones/zone/storagePools/storagePool
+            },
+            "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is
+                # either SCSI or NVME. For most machine types, the
+                # default is SCSI. Local SSDs can use either NVME or SCSI.
+                # In certain configurations, persistent disks can use NVMe. For more
+                # information, seeAbout
+                # persistent disks.
+            "kind": "compute#attachedDisk", # [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
+            "licenses": [ # [Output Only] Any valid publicly visible licenses.
+              "A String",
+            ],
+            "locked": True or False, # [Output Only] Whether to indicate the attached disk is locked. The locked
+                # disk is not allowed to be detached from the instance, or to be used as the
+                # source of the snapshot creation, and the image creation. The instance with
+                # at least one locked attached disk is not allow to be used as source of
+                # machine image creation, instant snapshot creation, and not allowed to be
+                # deleted with --keep-disk parameter set to true for locked disks.
+            "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
+                # in READ_WRITE mode.
+            "savedState": "A String", # For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
+                # field is set to PRESERVED if the LocalSSD data has been saved
+                # to a persistent location by customer request.  (see the
+                # discard_local_ssd option on Stop/Suspend).
+                # Read-only in the api.
+            "shieldedInstanceInitialState": { # Initial State for shielded instance, # [Output Only] shielded vm initial state stored on disk
+                # these are public keys which are safe to store in public
+              "dbs": [ # The Key Database (db).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "dbxs": [ # The forbidden key database (dbx).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "keks": [ # The Key Exchange Key (KEK).
+                {
+                  "content": "A String", # The raw content in the secure keys file.
+                  "fileType": "A String", # The file type of source file.
+                },
+              ],
+              "pk": { # The Platform Key (PK).
+                "content": "A String", # The raw content in the secure keys file.
+                "fileType": "A String", # The file type of source file.
+              },
+            },
+            "source": "A String", # Specifies a valid partial or full URL to an existing Persistent Disk
+                # resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
+                # is required.
+                #
+                # If desired, you can also attach existing non-root persistent disks using
+                # this property. This field is only applicable for persistent disks.
+                #
+                # Note that for InstanceTemplate, specify the disk name for zonal disk,
+                # and the URL for regional disk.
+            "type": "A String", # Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
+            "userLicenses": [ # [Output Only] A list of user provided licenses. It represents a list of
+                # URLs to the license resource. Unlike regular licenses, user provided
+                # licenses can be modified after the disk is created.
+              "A String",
+            ],
+          },
+        ],
         "machineTypes": [ # Full machine-type names, e.g. "n1-standard-16".
           "A String",
         ],
+        "minCpuPlatform": "A String", # Name of the minimum CPU platform to be used by this instance selection.
+            # e.g. 'Intel Ice Lake'.
         "rank": 42, # Preference of this instance selection. Lower number means higher
             # preference. MIG will first try to create a VM based on the machine-type
             # with lowest rank and fallback to next rank based on availability.
@@ -10200,6 +15602,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html
index 23a40b1b97..fa8f06e63c 100644
--- a/docs/dyn/compute_alpha.regionInstanceTemplates.html
+++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html
@@ -1488,6 +1488,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
       # applicable for regional resources.
@@ -2635,6 +2639,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
       # applicable for regional resources.
@@ -4151,6 +4159,10 @@ 
Method Details

             "A String",
           ],
         },
+        "workloadIdentityConfig": {
+          "identity": "A String",
+          "identityCertificateEnabled": True or False,
+        },
       },
       "region": "A String", # [Output Only] URL of the region where the instance template resides. Only
           # applicable for regional resources.
diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html
index a4b4ef937f..8918ba3363 100644
--- a/docs/dyn/compute_alpha.regionInstances.html
+++ b/docs/dyn/compute_alpha.regionInstances.html
@@ -1669,6 +1669,10 @@ 
Method Details

         "A String",
       ],
     },
+    "workloadIdentityConfig": {
+      "identity": "A String",
+      "identityCertificateEnabled": True or False,
+    },
   },
   "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
       # bulk.
diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html
index 5921b50373..679d793eac 100644
--- a/docs/dyn/compute_alpha.reservations.html
+++ b/docs/dyn/compute_alpha.reservations.html
@@ -121,7 +121,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of reservations.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html
index 65964a3802..c7e15015f4 100644
--- a/docs/dyn/compute_alpha.resourcePolicies.html
+++ b/docs/dyn/compute_alpha.resourcePolicies.html
@@ -237,6 +237,8 @@ 
Method Details

           },
           "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
               # It specifies the failure bucket separation
+            "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+                # specified, the default is AUTO_CONNECT.
             "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
                 # instances are in different availability domain, they are not in the same
                 # low latency network.
@@ -779,6 +781,8 @@ 
Method Details

   },
   "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
       # It specifies the failure bucket separation
+    "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+        # specified, the default is AUTO_CONNECT.
     "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
         # instances are in different availability domain, they are not in the same
         # low latency network.
@@ -1318,6 +1322,8 @@ 
Method Details

   },
   "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
       # It specifies the failure bucket separation
+    "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+        # specified, the default is AUTO_CONNECT.
     "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
         # instances are in different availability domain, they are not in the same
         # low latency network.
@@ -1855,6 +1861,8 @@ 
Method Details

       },
       "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
           # It specifies the failure bucket separation
+        "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+            # specified, the default is AUTO_CONNECT.
         "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
             # instances are in different availability domain, they are not in the same
             # low latency network.
@@ -2074,6 +2082,8 @@ 
Method Details

   },
   "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
       # It specifies the failure bucket separation
+    "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+        # specified, the default is AUTO_CONNECT.
     "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
         # instances are in different availability domain, they are not in the same
         # low latency network.
diff --git a/docs/dyn/compute_alpha.rolloutPlans.html b/docs/dyn/compute_alpha.rolloutPlans.html
new file mode 100644
index 0000000000..683ca5206d
--- /dev/null
+++ b/docs/dyn/compute_alpha.rolloutPlans.html
@@ -0,0 +1,1107 @@
+
+
+
+
Compute Engine API . rolloutPlans

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  delete(project, rolloutPlan, requestId=None, x__xgafv=None)

+
Deletes a RolloutPlan.

+

+  get(project, rolloutPlan, x__xgafv=None)

+
Gets details of a single project-scoped RolloutPlan.

+

+  insert(project, body=None, requestId=None, x__xgafv=None)

+
Creates a new RolloutPlan in a given project and location.

+

+  list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists RolloutPlans in a given project and location.

+

+  list_next()

+
Retrieves the next page of results.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(project, rolloutPlan, requestId=None, x__xgafv=None)
+  
Deletes a RolloutPlan.
+
+Args:
+  project: string, Project ID for this request. (required)
+  rolloutPlan: string, Name of the RolloutPlan resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+

+    get(project, rolloutPlan, x__xgafv=None)
+  
Gets details of a single project-scoped RolloutPlan.
+
+Args:
+  project: string, Project ID for this request. (required)
+  rolloutPlan: string, Name of the persistent rollout plan to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing RolloutPlan object
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rolloutPlan", # [Output Only] Type of the resource. Always compute#rolloutPlan
+      # for rolloutPlans.
+  "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+      # scope is considered as ZONAL.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "waves": [ # Required. The waves included in this rollout plan.
+    { # A single wave in a rollout plan.
+      "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+      "number": "A String", # Output only. The wave number.
+      "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+          # required only if the resource being rolled out follows the Orchestrated
+          # pattern.
+        "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+            # multiple Delays to be specified, letting users set separate delays
+            # between batches of projects corresponding to different locations and
+            # batches of projects corresponding to the same location.
+          { # Options to control the delay, if any, between batches of projects.
+            "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                # projects corresponding to different locations, or also between
+                # batches of projects corresponding to the same location.
+                #
+                # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+            "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                # projects. A zero duration corresponds to no delay.
+            "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                # each batch, or if the total processing time for each batch will be
+                # padded if needed to meet the specified duration.
+                #
+                # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+          },
+        ],
+        "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+        "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+            # parallel.
+      },
+      "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+          # defined in a wave, so a resource must satisfy the criteria of *all* the
+          # specified selectors to be in scope for the wave.
+        { # A selector which specifies what resource(s) are included in a given wave.
+          "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+            "includedLocations": [ # Optional. Example: "us-central1-a"
+              "A String",
+            ],
+          },
+          "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+              # nodes such as projects, folders, orgs.
+            "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+              "A String",
+            ],
+            "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+              "A String",
+            ],
+            "includedProjects": [ # Optional. Format: "projects/{project_id}"
+              "A String",
+            ],
+          },
+        },
+      ],
+      "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+        "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+          "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+              # after all changes in the wave are rolled out.
+        },
+        "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+            # a metadata object, the appropriate metadata field mapping to the
+            # validation type must be provided in the validation message. Possible
+            # values are in quotes below alongside an explanation:
+            #   "manual": The system waits for an end-user approval API before
+            #     progressing to the next wave.
+            #   "time": The system waits for a user specified duration before
+            #     progressing to the next wave. TimeBasedValidation must be provided.
+      },
+    },
+  ],
+}

+

+
+

+    insert(project, body=None, requestId=None, x__xgafv=None)
+  
Creates a new RolloutPlan in a given project and location.
+
+Args:
+  project: string, Project ID for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing RolloutPlan object
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rolloutPlan", # [Output Only] Type of the resource. Always compute#rolloutPlan
+      # for rolloutPlans.
+  "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+      # scope is considered as ZONAL.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "waves": [ # Required. The waves included in this rollout plan.
+    { # A single wave in a rollout plan.
+      "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+      "number": "A String", # Output only. The wave number.
+      "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+          # required only if the resource being rolled out follows the Orchestrated
+          # pattern.
+        "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+            # multiple Delays to be specified, letting users set separate delays
+            # between batches of projects corresponding to different locations and
+            # batches of projects corresponding to the same location.
+          { # Options to control the delay, if any, between batches of projects.
+            "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                # projects corresponding to different locations, or also between
+                # batches of projects corresponding to the same location.
+                #
+                # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+            "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                # projects. A zero duration corresponds to no delay.
+            "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                # each batch, or if the total processing time for each batch will be
+                # padded if needed to meet the specified duration.
+                #
+                # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+          },
+        ],
+        "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+        "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+            # parallel.
+      },
+      "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+          # defined in a wave, so a resource must satisfy the criteria of *all* the
+          # specified selectors to be in scope for the wave.
+        { # A selector which specifies what resource(s) are included in a given wave.
+          "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+            "includedLocations": [ # Optional. Example: "us-central1-a"
+              "A String",
+            ],
+          },
+          "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+              # nodes such as projects, folders, orgs.
+            "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+              "A String",
+            ],
+            "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+              "A String",
+            ],
+            "includedProjects": [ # Optional. Format: "projects/{project_id}"
+              "A String",
+            ],
+          },
+        },
+      ],
+      "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+        "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+          "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+              # after all changes in the wave are rolled out.
+        },
+        "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+            # a metadata object, the appropriate metadata field mapping to the
+            # validation type must be provided in the validation message. Possible
+            # values are in quotes below alongside an explanation:
+            #   "manual": The system waits for an end-user approval API before
+            #     progressing to the next wave.
+            #   "time": The system waits for a user specified duration before
+            #     progressing to the next wave. TimeBasedValidation must be provided.
+      },
+    },
+  ],
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+

+    list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists RolloutPlans in a given project and location.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of RolloutPlan resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of RolloutPlan resources.
+    { # Message describing RolloutPlan object
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#rolloutPlan", # [Output Only] Type of the resource. Always compute#rolloutPlan
+          # for rolloutPlans.
+      "locationScope": "A String", # The location scope of the rollout plan. If not specified, the location
+          # scope is considered as ZONAL.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "waves": [ # Required. The waves included in this rollout plan.
+        { # A single wave in a rollout plan.
+          "displayName": "A String", # Optional. The display name of this wave of the rollout plan.
+          "number": "A String", # Output only. The wave number.
+          "orchestrationOptions": { # Options to control the pace of orchestration of a wave. These options are # Optional. The orchestration options for this wave.
+              # required only if the resource being rolled out follows the Orchestrated
+              # pattern.
+            "delays": [ # Optional. Delays, if any, to be added between batches of projects. We allow
+                # multiple Delays to be specified, letting users set separate delays
+                # between batches of projects corresponding to different locations and
+                # batches of projects corresponding to the same location.
+              { # Options to control the delay, if any, between batches of projects.
+                "delimiter": "A String", # Optional. Controls whether the delay should only be added between batches of
+                    # projects corresponding to different locations, or also between
+                    # batches of projects corresponding to the same location.
+                    #
+                    # Must be set to DELIMITER_UNSPECIFIED if no delay is to be added.
+                "duration": "A String", # Optional. The duration of the delay, if any, to be added between batches of
+                    # projects. A zero duration corresponds to no delay.
+                "type": "A String", # Optional. Controls whether the specified duration is to be added at the end of
+                    # each batch, or if the total processing time for each batch will be
+                    # padded if needed to meet the specified duration.
+                    #
+                    # Must be set to TYPE_UNSPECIFIED if no delay is to be added.
+              },
+            ],
+            "maxConcurrentLocations": "A String", # Optional. Maximum number of locations to be orchestrated in parallel.
+            "maxConcurrentResourcesPerLocation": "A String", # Optional. Maximum number of resources to be orchestrated per location in
+                # parallel.
+          },
+          "selectors": [ # Required. The selectors for this wave. There is a logical AND between each selector
+              # defined in a wave, so a resource must satisfy the criteria of *all* the
+              # specified selectors to be in scope for the wave.
+            { # A selector which specifies what resource(s) are included in a given wave.
+              "locationSelector": { # Roll out to resources by location. # Optional. Roll out to resources by Cloud locations.
+                "includedLocations": [ # Optional. Example: "us-central1-a"
+                  "A String",
+                ],
+              },
+              "resourceHierarchySelector": { # Roll out to resources by Cloud Resource Manager resource hierarchy # Optional. Roll out to resources by Cloud Resource Manager resource hierarchy.
+                  # nodes such as projects, folders, orgs.
+                "includedFolders": [ # Optional. Format: "folders/{folder_id}"
+                  "A String",
+                ],
+                "includedOrganizations": [ # Optional. Format: "organizations/{organization_id}"
+                  "A String",
+                ],
+                "includedProjects": [ # Optional. Format: "projects/{project_id}"
+                  "A String",
+                ],
+              },
+            },
+          ],
+          "validation": { # The validation to be performed before progressing to the next wave. # Required. The validation to be performed at the end of this wave.
+            "timeBasedValidationMetadata": { # Metadata required if type = "time". # Optional. Metadata required if type = "time".
+              "waitDuration": "A String", # Optional. The duration that the system waits in between waves. This wait starts
+                  # after all changes in the wave are rolled out.
+            },
+            "type": "A String", # Required. The type of the validation. If a type of validation is associated with
+                # a metadata object, the appropriate metadata field mapping to the
+                # validation type must be provided in the validation message. Possible
+                # values are in quotes below alongside an explanation:
+                #   "manual": The system waits for an end-user approval API before
+                #     progressing to the next wave.
+                #   "time": The system waits for a user specified duration before
+                #     progressing to the next wave. TimeBasedValidation must be provided.
+          },
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.rollouts.html b/docs/dyn/compute_alpha.rollouts.html
new file mode 100644
index 0000000000..78f3a7dac5
--- /dev/null
+++ b/docs/dyn/compute_alpha.rollouts.html
@@ -0,0 +1,982 @@
+
+
+
+
Compute Engine API . rollouts

+
Instance Methods

+

+  cancel(project, rollout, requestId=None, rollback=None, x__xgafv=None)

+
Cancels a Rollout.

+

+  close()

+
Close httplib2 connections.

+

+  delete(project, rollout, requestId=None, x__xgafv=None)

+
Deletes a Rollout.

+

+  get(project, rollout, x__xgafv=None)

+
Gets details of a single project-scoped Rollout.

+

+  list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists Rollouts in a given project and location.

+

+  list_next()

+
Retrieves the next page of results.

+
Method Details

+

+    cancel(project, rollout, requestId=None, rollback=None, x__xgafv=None)
+  
Cancels a Rollout.
+
+Args:
+  project: string, Project ID for this request. (required)
+  rollout: string, Name of the Rollout resource to cancel. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  rollback: boolean, Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel
+the rollout without taking any further actions. Note that products must
+support at least one of these options, however, it does not need to support
+both.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(project, rollout, requestId=None, x__xgafv=None)
+  
Deletes a Rollout.
+
+Args:
+  project: string, Project ID for this request. (required)
+  rollout: string, Name of the Rollout resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+

+    get(project, rollout, x__xgafv=None)
+  
Gets details of a single project-scoped Rollout.
+
+Args:
+  project: string, Project ID for this request. (required)
+  rollout: string, Name of the persistent rollout to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represent a Rollout resource.
+  "cancellationTime": "A String", # Output only. The timestamp at which the Rollout was cancelled.
+  "completionTime": "A String", # Output only. The timestamp at which the Rollout was completed.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "currentWaveNumber": "A String", # Output only. The number of the currently running wave.
+      # Ex. 1
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "etag": "A String", # Output only. etag of the Rollout
+      # Ex. abc1234
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#rollout", # [Output Only] Type of the resource. Always compute#rollout
+      # for rollouts.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out.
+    "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
+        # integration model with ProgressiveRollout.
+      "conflictBehavior": "A String", # Required. Specifies the behavior of the Rollout if an out of band update is
+          # detected in a project during a Rollout. It can be one of the following
+          # values:
+          # 1) overwrite : Overwrite the local value with the rollout value.
+          # 2) no_overwrite : Do not overwrite the local value with the rollout
+          # value.
+      "orchestrationAction": "A String", # Required. Orchestration action during the Rollout. It can be one of the following
+          # values:
+          # 1) "update": Resources will be updated by the rollout.
+          # 2) "delete": Resources will be deleted by the rollout.
+      "orchestrationSource": "A String", # Required. Fully qualified resource name of the resource which contains the source
+          # of truth of the configuration being rolled out across
+          # locations/projects. For example, in the case of a global Rollout which
+          # is applied across regions, this contains the name of the global
+          # resource created by the user which contains a payload for a resource
+          # that is orchestrated across regions. This follows the following format:
+          # //.googleapis.com/organizations//locations/global//
+          # e.g.
+          # //osconfig.googleapis.com/organizations/1/locations/global/policyOrchestrators/po1
+    },
+  },
+  "rolloutPlan": "A String", # Required. Rollout Plan used to model the Rollout.
+      # Ex. progressiverollout.googleapis.com/v1/organizations/1/rolloutPlans
+      # Ex. progressiverollout.googleapis.com/v1/folders/1/rolloutPlans
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Output only. The current state of the Rollout.
+  "waveDetails": [ # Output only. Details about each wave of the rollout.
+    { # Additional metadata about the status of each wave provided by the server.
+      "orchestratedWaveDetails": { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
+          # Integration model.
+          # model.
+        "completedResourcesCount": "A String", # Output only. Resource completed so far.
+        "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources.
+        "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
+            # stopped retrying. There may be some successful resources rolled out in
+            # the wave as the location may have failed later in the Rollout.
+          "A String",
+        ],
+        "failedResourcesCount": "A String", # Output only. Resources failed.
+      },
+      "waveDisplayName": "A String", # Output only. Wave name.
+          # Ex. wave1
+      "waveNumber": "A String", # Output only. System generated number for the wave.
+    },
+  ],
+}

+

+
+

+    list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists Rollouts in a given project and location.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of Rollout resources.
+    { # Represent a Rollout resource.
+      "cancellationTime": "A String", # Output only. The timestamp at which the Rollout was cancelled.
+      "completionTime": "A String", # Output only. The timestamp at which the Rollout was completed.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "currentWaveNumber": "A String", # Output only. The number of the currently running wave.
+          # Ex. 1
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "etag": "A String", # Output only. etag of the Rollout
+          # Ex. abc1234
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#rollout", # [Output Only] Type of the resource. Always compute#rollout
+          # for rollouts.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "rolloutEntity": { # Specifications of the resource to roll out. # Required. The resource being rolled out.
+        "orchestratedEntity": { # This message is used if the resource type follows the Orchestrated # Optional. Entity details for products using the Orchestrated Integration model.
+            # integration model with ProgressiveRollout.
+          "conflictBehavior": "A String", # Required. Specifies the behavior of the Rollout if an out of band update is
+              # detected in a project during a Rollout. It can be one of the following
+              # values:
+              # 1) overwrite : Overwrite the local value with the rollout value.
+              # 2) no_overwrite : Do not overwrite the local value with the rollout
+              # value.
+          "orchestrationAction": "A String", # Required. Orchestration action during the Rollout. It can be one of the following
+              # values:
+              # 1) "update": Resources will be updated by the rollout.
+              # 2) "delete": Resources will be deleted by the rollout.
+          "orchestrationSource": "A String", # Required. Fully qualified resource name of the resource which contains the source
+              # of truth of the configuration being rolled out across
+              # locations/projects. For example, in the case of a global Rollout which
+              # is applied across regions, this contains the name of the global
+              # resource created by the user which contains a payload for a resource
+              # that is orchestrated across regions. This follows the following format:
+              # //.googleapis.com/organizations//locations/global//
+              # e.g.
+              # //osconfig.googleapis.com/organizations/1/locations/global/policyOrchestrators/po1
+        },
+      },
+      "rolloutPlan": "A String", # Required. Rollout Plan used to model the Rollout.
+          # Ex. progressiverollout.googleapis.com/v1/organizations/1/rolloutPlans
+          # Ex. progressiverollout.googleapis.com/v1/folders/1/rolloutPlans
+      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Output only. The current state of the Rollout.
+      "waveDetails": [ # Output only. Details about each wave of the rollout.
+        { # Additional metadata about the status of each wave provided by the server.
+          "orchestratedWaveDetails": { # Details of the wave for products using the Orchestrated integration # Output only. Additional details of the wave for products using the Orchestrated
+              # Integration model.
+              # model.
+            "completedResourcesCount": "A String", # Output only. Resource completed so far.
+            "estimatedTotalResourcesCount": "A String", # Output only. Estimated total count of resources.
+            "failedLocations": [ # Output only. Locations that failed during orchestration, and ProgressiveRollout
+                # stopped retrying. There may be some successful resources rolled out in
+                # the wave as the location may have failed later in the Rollout.
+              "A String",
+            ],
+            "failedResourcesCount": "A String", # Output only. Resources failed.
+          },
+          "waveDisplayName": "A String", # Output only. Wave name.
+              # Ex. wave1
+          "waveNumber": "A String", # Output only. System generated number for the wave.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html
index c96b311b14..975f40d78a 100644
--- a/docs/dyn/compute_alpha.routers.html
+++ b/docs/dyn/compute_alpha.routers.html
@@ -2922,7 +2922,9 @@ 
Method Details

             # cases where multiple routes have equal prefix length, the one with the
             # lowest-numbered priority value wins. The default value is `1000`. The
             # priority value must be from `0` to `65535`, inclusive.
-        "routeStatus": "A String", # [Output only] The status of the route.
+        "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+            # dynamic routes learned by Cloud Routers. This status is not applicable
+            # to static routes.
         "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
             # values:
             # - 'TRANSIT' for a transit route that this router learned from
@@ -3096,7 +3098,9 @@ 
Method Details

             # cases where multiple routes have equal prefix length, the one with the
             # lowest-numbered priority value wins. The default value is `1000`. The
             # priority value must be from `0` to `65535`, inclusive.
-        "routeStatus": "A String", # [Output only] The status of the route.
+        "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+            # dynamic routes learned by Cloud Routers. This status is not applicable
+            # to static routes.
         "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
             # values:
             # - 'TRANSIT' for a transit route that this router learned from
@@ -3268,7 +3272,9 @@ 
Method Details

                 # cases where multiple routes have equal prefix length, the one with the
                 # lowest-numbered priority value wins. The default value is `1000`. The
                 # priority value must be from `0` to `65535`, inclusive.
-            "routeStatus": "A String", # [Output only] The status of the route.
+            "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+                # dynamic routes learned by Cloud Routers. This status is not applicable
+                # to static routes.
             "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
                 # values:
                 # - 'TRANSIT' for a transit route that this router learned from
diff --git a/docs/dyn/compute_alpha.routes.html b/docs/dyn/compute_alpha.routes.html
index 7f4796802f..ffd8a22d44 100644
--- a/docs/dyn/compute_alpha.routes.html
+++ b/docs/dyn/compute_alpha.routes.html
@@ -523,7 +523,9 @@ 
Method Details

       # cases where multiple routes have equal prefix length, the one with the
       # lowest-numbered priority value wins. The default value is `1000`. The
       # priority value must be from `0` to `65535`, inclusive.
-  "routeStatus": "A String", # [Output only] The status of the route.
+  "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+      # dynamic routes learned by Cloud Routers. This status is not applicable
+      # to static routes.
   "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
       # values:
       # - 'TRANSIT' for a transit route that this router learned from
@@ -703,7 +705,9 @@ 
Method Details

       # cases where multiple routes have equal prefix length, the one with the
       # lowest-numbered priority value wins. The default value is `1000`. The
       # priority value must be from `0` to `65535`, inclusive.
-  "routeStatus": "A String", # [Output only] The status of the route.
+  "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+      # dynamic routes learned by Cloud Routers. This status is not applicable
+      # to static routes.
   "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
       # values:
       # - 'TRANSIT' for a transit route that this router learned from
@@ -1246,7 +1250,9 @@ 
Method Details

           # cases where multiple routes have equal prefix length, the one with the
           # lowest-numbered priority value wins. The default value is `1000`. The
           # priority value must be from `0` to `65535`, inclusive.
-      "routeStatus": "A String", # [Output only] The status of the route.
+      "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+          # dynamic routes learned by Cloud Routers. This status is not applicable
+          # to static routes.
       "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
           # values:
           # - 'TRANSIT' for a transit route that this router learned from
diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html
index daefa78dae..881cd4d492 100644
--- a/docs/dyn/compute_alpha.subnetworks.html
+++ b/docs/dyn/compute_alpha.subnetworks.html
@@ -75,7 +75,7 @@
 
Compute Engine API . subnetworks

 
Instance Methods

 

-  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)

 
Retrieves an aggregated list of subnetworks.

 

   aggregatedList_next()

@@ -124,7 +124,7 @@ 
Instance Methods

 
Returns permissions that a caller has on the specified resource.

 
Method Details

 

-    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)
   
Retrieves an aggregated list of subnetworks.
 
 To prevent failure, Google recommends that you set the
@@ -224,6 +224,14 @@ 
Method Details

 with an error code.
   serviceProjectNumber: string, The Shared VPC service project id or service project number for which
 aggregated list request is invoked for subnetworks list-usable api.
+  views: string, Defines the extra views returned back in the subnetwork resource.
+Supported values:
+   
+   - WITH_UTILIZATION: Utilization data is included in the
+   response. (repeated)
+    Allowed values
+      DEFAULT - 
+      WITH_UTILIZATION - Utilization data is included in the response.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html
index e226ff5732..ddd34be0da 100644
--- a/docs/dyn/compute_alpha.zoneQueuedResources.html
+++ b/docs/dyn/compute_alpha.zoneQueuedResources.html
@@ -1797,6 +1797,10 @@ 
Method Details

                   "A String",
                 ],
               },
+              "workloadIdentityConfig": {
+                "identity": "A String",
+                "identityCertificateEnabled": True or False,
+              },
             },
             "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
                 # bulk.
@@ -4271,6 +4275,10 @@ 
Method Details

           "A String",
         ],
       },
+      "workloadIdentityConfig": {
+        "identity": "A String",
+        "identityCertificateEnabled": True or False,
+      },
     },
     "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
         # bulk.
@@ -6085,6 +6093,10 @@ 
Method Details

           "A String",
         ],
       },
+      "workloadIdentityConfig": {
+        "identity": "A String",
+        "identityCertificateEnabled": True or False,
+      },
     },
     "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
         # bulk.
@@ -8263,6 +8275,10 @@ 
Method Details

               "A String",
             ],
           },
+          "workloadIdentityConfig": {
+            "identity": "A String",
+            "identityCertificateEnabled": True or False,
+          },
         },
         "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in
             # bulk.
diff --git a/docs/dyn/compute_beta.acceleratorTypes.html b/docs/dyn/compute_beta.acceleratorTypes.html
index 686d74adc4..76c49401c3 100644
--- a/docs/dyn/compute_beta.acceleratorTypes.html
+++ b/docs/dyn/compute_beta.acceleratorTypes.html
@@ -97,7 +97,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of accelerator types.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.addresses.html b/docs/dyn/compute_beta.addresses.html
index 84ae0766b9..6834510c3a 100644
--- a/docs/dyn/compute_beta.addresses.html
+++ b/docs/dyn/compute_beta.addresses.html
@@ -112,7 +112,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of addresses.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.autoscalers.html b/docs/dyn/compute_beta.autoscalers.html
index 148e82cd34..65b540d435 100644
--- a/docs/dyn/compute_beta.autoscalers.html
+++ b/docs/dyn/compute_beta.autoscalers.html
@@ -112,7 +112,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of autoscalers.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.backendBuckets.html b/docs/dyn/compute_beta.backendBuckets.html
index 10e7b23e59..9132bfb838 100644
--- a/docs/dyn/compute_beta.backendBuckets.html
+++ b/docs/dyn/compute_beta.backendBuckets.html
@@ -640,7 +640,7 @@ 
Method Details

                 # negative caching when a policy exists.
               { # Specify CDN TTLs for response error codes.
                 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                     # specified as values, and you cannot specify a status code more than
                     # once.
                 "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -719,6 +719,10 @@ 
Method Details

               "a_key": "A String",
             },
           },
+          "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+              # resides. This field is not applicable to global backend buckets.
+              # You must specify this field as part of the HTTP request URL. It is
+              # not settable as a field in the request body.
           "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
           "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
             {
@@ -1488,7 +1492,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1567,6 +1571,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
@@ -2055,7 +2063,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2134,6 +2142,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
@@ -2617,7 +2629,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2696,6 +2708,10 @@ 
Method Details

           "a_key": "A String",
         },
       },
+      "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+          # resides. This field is not applicable to global backend buckets.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
         {
@@ -2940,7 +2956,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -3019,6 +3035,10 @@ 
Method Details

           "a_key": "A String",
         },
       },
+      "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+          # resides. This field is not applicable to global backend buckets.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
         {
@@ -3205,7 +3225,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -3284,6 +3304,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
@@ -4872,7 +4896,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -4951,6 +4975,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html
index 5f30b8a376..960bc25cfa 100644
--- a/docs/dyn/compute_beta.backendServices.html
+++ b/docs/dyn/compute_beta.backendServices.html
@@ -439,7 +439,7 @@ 
Method Details

   
Retrieves the list of all BackendService resources, regional and global,
 available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -612,7 +612,8 @@ 
Method Details

                   "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                       # balancing mode. The valid range is [0.0, 1.0].
                   "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                      # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                      # long and match the regular expression
+                      # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                       # first character must be a lowercase letter, and all following
                       # characters must be a dash, period, underscore, lowercase letter, or
                       # digit, except the last character, which cannot be a dash, period, or
@@ -808,7 +809,7 @@ 
Method Details

                 # negative caching when a policy exists.
               { # Specify CDN TTLs for response error codes.
                 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                     # specified as values, and you cannot specify a status code more than
                     # once.
                 "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1000,7 +1001,8 @@ 
Method Details

                 # locality_lb_policy.
               "dryRun": True or False, # If true, the metric data is not used for load balancing.
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -1802,6 +1804,44 @@ 
Method Details

                 # networksecurity.googleapis.com namespace. Can be used in authenticating
                 # TLS connections to the backend, as specified by the authenticationMode
                 # field. Can only be specified if authenticationMode is not NONE.
+            "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+                #
+                #
+                # Use this property to configure the load balancer back-end to use
+                # certificates and roots of trust provisioned by the Managed Workload
+                # Identity system.
+                #
+                #  The `identity` property is the
+                # fully-specified SPIFFE ID to use in the SVID presented by the Load
+                # Balancer Workload.
+                #
+                #  The SPIFFE ID must be a resource starting with the
+                # `trustDomain` property value, followed by the path to the Managed
+                # Workload Identity.
+                #
+                #  Supported SPIFFE ID format:
+                #
+                #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+                #
+                #
+                # The Trust Domain within the Managed Identity must refer to a valid
+                # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+                # will be inherited from the Workload Identity Pool.
+                #
+                #  Restrictions:
+                #
+                #    - If you set the `identity` property, you cannot manually set
+                #    the following fields:
+                #        - tlsSettings.sni
+                #       - tlsSettings.subjectAltNames
+                #       - tlsSettings.authenticationConfig
+                #
+                #
+                # When defining a `identity` for a RegionBackendServices, the
+                # corresponding Workload Identity Pool must have a ca_pool
+                # configured in the same region.
+                #
+                #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
             "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
                 # balancer sends this string as the SNI hostname in the TLS connection to
                 # the backend, and requires that this string match a Subject Alternative
@@ -2561,7 +2601,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -2757,7 +2798,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2949,7 +2990,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -3751,6 +3793,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
@@ -4999,7 +5079,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -5195,7 +5276,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -5387,7 +5468,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -6189,6 +6271,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
@@ -6659,7 +6779,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -6855,7 +6976,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -7047,7 +7168,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -7849,6 +7971,44 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+            #
+            #
+            # Use this property to configure the load balancer back-end to use
+            # certificates and roots of trust provisioned by the Managed Workload
+            # Identity system.
+            #
+            #  The `identity` property is the
+            # fully-specified SPIFFE ID to use in the SVID presented by the Load
+            # Balancer Workload.
+            #
+            #  The SPIFFE ID must be a resource starting with the
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
+            #
+            #  Supported SPIFFE ID format:
+            #
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+            #
+            #
+            # The Trust Domain within the Managed Identity must refer to a valid
+            # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+            # will be inherited from the Workload Identity Pool.
+            #
+            #  Restrictions:
+            #
+            #    - If you set the `identity` property, you cannot manually set
+            #    the following fields:
+            #        - tlsSettings.sni
+            #       - tlsSettings.subjectAltNames
+            #       - tlsSettings.authenticationConfig
+            #
+            #
+            # When defining a `identity` for a RegionBackendServices, the
+            # corresponding Workload Identity Pool must have a ca_pool
+            # configured in the same region.
+            #
+            #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
         "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
             # balancer sends this string as the SNI hostname in the TLS connection to
             # the backend, and requires that this string match a Subject Alternative
@@ -8080,7 +8240,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -8276,7 +8437,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -8468,7 +8629,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -9270,6 +9432,44 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+            #
+            #
+            # Use this property to configure the load balancer back-end to use
+            # certificates and roots of trust provisioned by the Managed Workload
+            # Identity system.
+            #
+            #  The `identity` property is the
+            # fully-specified SPIFFE ID to use in the SVID presented by the Load
+            # Balancer Workload.
+            #
+            #  The SPIFFE ID must be a resource starting with the
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
+            #
+            #  Supported SPIFFE ID format:
+            #
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+            #
+            #
+            # The Trust Domain within the Managed Identity must refer to a valid
+            # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+            # will be inherited from the Workload Identity Pool.
+            #
+            #  Restrictions:
+            #
+            #    - If you set the `identity` property, you cannot manually set
+            #    the following fields:
+            #        - tlsSettings.sni
+            #       - tlsSettings.subjectAltNames
+            #       - tlsSettings.authenticationConfig
+            #
+            #
+            # When defining a `identity` for a RegionBackendServices, the
+            # corresponding Workload Identity Pool must have a ca_pool
+            # configured in the same region.
+            #
+            #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
         "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
             # balancer sends this string as the SNI hostname in the TLS connection to
             # the backend, and requires that this string match a Subject Alternative
@@ -9444,7 +9644,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -9640,7 +9841,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -9832,7 +10033,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -10634,6 +10836,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
@@ -12500,7 +12740,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -12696,7 +12937,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -12888,7 +13129,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -13690,6 +13932,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
diff --git a/docs/dyn/compute_beta.diskTypes.html b/docs/dyn/compute_beta.diskTypes.html
index 4cb1c05a43..3a222043d2 100644
--- a/docs/dyn/compute_beta.diskTypes.html
+++ b/docs/dyn/compute_beta.diskTypes.html
@@ -97,7 +97,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of disk types.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.disks.html b/docs/dyn/compute_beta.disks.html
index 0f6cb92e2a..159a5e9e30 100644
--- a/docs/dyn/compute_beta.disks.html
+++ b/docs/dyn/compute_beta.disks.html
@@ -438,7 +438,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of persistent disks.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html
index 852e664996..c8dc8e9520 100644
--- a/docs/dyn/compute_beta.firewallPolicies.html
+++ b/docs/dyn/compute_beta.firewallPolicies.html
@@ -114,7 +114,7 @@ 
Instance Methods

   list(filter=None, maxResults=None, orderBy=None, pageToken=None, parentId=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists all the policies that have been configured for the specified

 

-  listAssociations(targetResource=None, x__xgafv=None)

+  listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)

 
Lists associations of a specified target, i.e., organization or folder.

 

   list_next()

@@ -4403,10 +4403,13 @@ 
Method Details

 

 
 

-    listAssociations(targetResource=None, x__xgafv=None)
+    listAssociations(includeInheritedPolicies=None, targetResource=None, x__xgafv=None)
   
Lists associations of a specified target, i.e., organization or folder.
 
 Args:
+  includeInheritedPolicies: boolean, If set to "true", the response will contain a list of all associations for
+the containing folders and the containing organization of the target. The
+parameter has no effect if the target is an organization.
   targetResource: string, The target resource to list associations. It is an organization, or a
 folder.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/compute_beta.forwardingRules.html b/docs/dyn/compute_beta.forwardingRules.html
index a8837d96a0..77ccb98a7f 100644
--- a/docs/dyn/compute_beta.forwardingRules.html
+++ b/docs/dyn/compute_beta.forwardingRules.html
@@ -115,7 +115,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of forwarding rules.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.futureReservations.html b/docs/dyn/compute_beta.futureReservations.html
index 38f9319549..26d4d0ea4d 100644
--- a/docs/dyn/compute_beta.futureReservations.html
+++ b/docs/dyn/compute_beta.futureReservations.html
@@ -109,7 +109,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of future reservations.
 
-To prevent failure, recommendation is that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.globalVmExtensionPolicies.html b/docs/dyn/compute_beta.globalVmExtensionPolicies.html
new file mode 100644
index 0000000000..67c82c5c53
--- /dev/null
+++ b/docs/dyn/compute_beta.globalVmExtensionPolicies.html
@@ -0,0 +1,464 @@
+
+
+
+
Compute Engine API . globalVmExtensionPolicies

+
Instance Methods

+

+  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+
Retrieves the list of all VM Extension Policy resources

+

+  aggregatedList_next()

+
Retrieves the next page of results.

+

+  close()

+
Close httplib2 connections.

+

+  get(project, globalVmExtensionPolicy, x__xgafv=None)

+
Gets details of a global VM extension policy.

+
Method Details

+

+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+  
Retrieves the list of all VM Extension Policy resources
+available to the specified project.
+
+To prevent failure, it's recommended that you set the
+`returnPartialSuccess` parameter to `true`.
+
+Args:
+  project: string, Name of the project scoping this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region,
+global) should be included in the response. For new resource types added
+after this field, the flag has no effect as new resource types will always
+include every visible scope for each scope type in response. For resource
+types which predate this field, if this flag is omitted or false, only
+scopes of the scope types where the resource type is expected to be found
+will be included.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  serviceProjectNumber: string, The Shared VPC service project id or service project number for which
+aggregated list request is invoked for subnetworks list-usable api.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the aggregated list of VM extension policies.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": { # A list of VmExtensionPoliciesScopedList resources.
+    "a_key": { # Name of the scope containing this set of VmExtensionPolicies.
+      "vmExtensionPolicies": [ # List of VmExtensionPolicy resources contained in this scope.
+        { # Represents a VM extension policy.
+          "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+              # text format.
+          "description": "A String", # An optional description of this resource.
+          "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
+              # configurations.
+            "a_key": { # Configuration for a specific VM extension.
+              "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+                  # version is used.
+              "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+            },
+          },
+          "globalResourceLink": "A String", # Optional. [Output Only] Link to the global policy that manages this zone policy, if
+              # applicable.
+          "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+              # defined by the server.
+          "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+              # *any* of the provided selectors (logical OR). If this list is empty, the
+              # policy applies to all VMs.
+            { # Defines how to select VMs to apply a zone VM extension policy.
+              "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+                  # labels.
+                "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+                    # VMs must have all of the labels specified in this map to be selected
+                    # (logical AND).
+                    #
+                    # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+                    # "value2")}, the VM labels must contain both ("key1", "value1") and
+                    # ("key2", "value2") to be selected. If the VM labels are ("key1",
+                    # "value1") and ("something", "else"), it will not be selected.
+                    #
+                    # If the map is empty, it's considered a match.
+                  "a_key": "A String",
+                },
+              },
+            },
+          ],
+          "kind": "compute#vmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+          "managedByGlobal": True or False, # Optional. [Output Only] Indicates if this policy is managed by a global policy.
+          "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+              # The name must be 1-63 characters long, and comply withRFC1035.
+              # Specifically, the name must be 1-63 characters long and match the regular
+              # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+              # which means the first character must be a lowercase letter, and all
+              # following characters must be a dash, lowercase letter, or digit, except
+              # the last character, which cannot be a dash.
+          "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+              # apply to the same extension.
+              # The policy priority is an integer from 0 to 65535, inclusive. Lower
+              # integers indicate higher priorities. If you do not specify a priority when
+              # creating a rule, it is assigned a priority of 1000. If priorities are
+              # equal, the policy with the more recent creation timestamp takes precedence.
+          "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+          "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+          "state": "A String", # Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.
+          "updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
+              # text format.
+        },
+      ],
+      "warning": { # Informational warning which replaces the list of
+          # backend services when the list is empty.
+        "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+            # Engine returns NO_RESULTS_ON_PAGE if there
+            # are no results in the response.
+        "data": [ # [Output Only] Metadata about this warning in key:
+            # value format. For example:
+            #
+            # "data": [
+            #   {
+            #    "key": "scope",
+            #    "value": "zones/us-east1-d"
+            #   }
+          {
+            "key": "A String", # [Output Only] A key that provides more detail on the warning being
+                # returned. For example, for warnings where there are no results in a list
+                # request for a particular zone, this key might be scope and
+                # the key value might be the zone name. Other examples might be a key
+                # indicating a deprecated resource and a suggested replacement, or a
+                # warning about invalid network settings (for example, if an instance
+                # attempts to perform IP forwarding but is not enabled for IP forwarding).
+            "value": "A String", # [Output Only] A warning data value corresponding to the key.
+          },
+        ],
+        "message": "A String", # [Output Only] A human-readable description of the warning code.
+      },
+    },
+  },
+  "kind": "compute#VmExtensionPolicyAggregatedList", # [Output Only] Type of resource. Alwayscompute#VmExtensionPolicyAggregatedList for lists of
+      # VmExtensionPolicies.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}

+

+
+

+    aggregatedList_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+

+    get(project, globalVmExtensionPolicy, x__xgafv=None)
+  
Gets details of a global VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  globalVmExtensionPolicy: string, Name of the GlobalVmExtensionPolicy resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing GlobalVmExtensionPolicy object.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "extensionPolicies": { # Required. Map from extension (eg: "cloudops") to its policy configuration.
+      # The key is the name of the extension.
+    "a_key": { # Policy for a single extension.
+      "pinnedVersion": "A String", # Optional. The version pinning for the extension.
+          # If empty, the extension will be installed with the latest version
+          # released by the extension producer.
+      "stringConfig": "A String", # Optional. String configuration. Any string payload that the extension
+          # understands.
+    },
+  },
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selector to target VMs for a policy.
+      # There is a logical "AND" between instance_selectors.
+    { # Selector to target VMs for a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applicable for a VM only if it matches all labels in # Optional. Labels within the LabelSelector are OR'd.
+          # the LabelSelector.
+        "inclusionLabels": { # Optional. Labels as key value pairs.
+            # A VM should contain all the pairs specified in this map to be selected;
+            # Labels within the LabelSelector are OR'ed.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#globalVmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Used to resolve conflicts when multiple policies are active for the same
+      # extension. Defaults to 0.
+      #
+      # Larger the number, higher the priority. When the priority is the same,
+      # the policy with the newer create time has higher priority.
+  "rolloutOperation": { # Represents the rollout operation # Required. The rollout strategy and status.
+    "rolloutInput": { # Required. The rollout input which defines the rollout plan.
+      "conflictBehavior": "A String", # Optional. [Optional] Specifies the behavior of the Rollout if a conflict is
+          # detected in a project during a Rollout. It can be one of the following
+          # values:
+          # 1) empty : don't overwrite the local value if conflict happens. This is
+          # the default behavior.
+          # 2) "overwrite" : Overwrite the local value with the rollout value.
+          # The concept of "conflict" applies to:
+          # 1) Insert action. If the zonal policy already exists when Insert
+          # happens, it's a conflict.
+          # 2) Update action. If the zonal policy was updated out of band by a
+          # zonal API, it's a conflict.
+      "name": "A String", # Optional. The name of the rollout plan.
+          # Ex.
+          # projects//locations/global/rolloutPlans/.
+      "predefinedRolloutPlan": "A String", # Optional. Predefined rollout plan.
+      "retryUuid": "A String", # Optional. The UUID of the retry action. Only set it if this is a retry
+          # for an existing resource. This is for the user re-populate the resource
+          # without changes. An error will be returned if the retry_uuid is set but
+          # the resource get modified.
+    },
+    "rolloutStatus": { # [Output Only] The rollout status of the policy.
+      "currentRollouts": [ # [Output Only] The current rollouts for the latest version of the
+          # resource. There should be only one current rollout, but for
+          # scalability, we make it repeated.
+        {
+          "rollout": "A String", # [Output Only] The name of the rollout.
+              # Ex. projects//locations/global/rollouts/.
+          "rolloutPlan": "A String", # [Output Only] The name of the rollout plan.
+              # Ex.
+              # projects//locations/global/rolloutPlans/.
+          "state": "A String", # [Output Only] The overall state of the rollout.
+        },
+      ],
+      "previousRollout": { # [Output Only] The last completed rollout resource. This field will not
+          # be populated until the first rollout is completed.
+        "rollout": "A String", # [Output Only] The name of the rollout.
+            # Ex. projects//locations/global/rollouts/.
+        "rolloutPlan": "A String", # [Output Only] The name of the rollout plan.
+            # Ex.
+            # projects//locations/global/rolloutPlans/.
+        "state": "A String", # [Output Only] The overall state of the rollout.
+      },
+    },
+  },
+  "scopedResourceStatus": "A String", # [Output Only] The scoped resource status. It's only for tracking the
+      # purging status of the policy.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
+      # text format.
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html
index aaaa80b0a2..e051960cb8 100644
--- a/docs/dyn/compute_beta.html
+++ b/docs/dyn/compute_beta.html
@@ -179,6 +179,11 @@ 
Instance Methods

 

 
Returns the globalPublicDelegatedPrefixes Resource.

 
+

+  globalVmExtensionPolicies()
+

+
Returns the globalVmExtensionPolicies Resource.

+
 

   healthChecks()
 

@@ -679,6 +684,11 @@ 
Instance Methods

 

 
Returns the zoneOperations Resource.

 
+

+  zoneVmExtensionPolicies()
+

+
Returns the zoneVmExtensionPolicies Resource.

+
 

   zones()
 

diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html
index af4c41ae70..f6222fa5f9 100644
--- a/docs/dyn/compute_beta.instanceGroupManagers.html
+++ b/docs/dyn/compute_beta.instanceGroupManagers.html
@@ -104,6 +104,9 @@ 
Instance Methods

 

   get(project, zone, instanceGroupManager, x__xgafv=None)

 
Returns all of the details about the specified managed instance group.

+

+  getAvailableAcceleratorTopologies(project, zone, resourceId, x__xgafv=None)

+
Returns information about available accelerator topologies for a given MIG.

 

   insert(project, zone, body=None, requestId=None, x__xgafv=None)

 
Creates a managed instance group using the information that you specify

@@ -782,6 +785,12 @@ 
Method Details

                 #    About repairing VMs in a MIG.
             "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
               "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+                  # Valid values are:
+                  #
+                  #    - NO (default): MIG cannot change a VM's zone during a
+                  #    repair.
+                  #    - YES: MIG can select a different zone for the VM during
+                  #    a repair.
             },
           },
           "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -3058,6 +3067,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -3491,6 +3506,36 @@ 
Method Details

 }

 

 
+

+    getAvailableAcceleratorTopologies(project, zone, resourceId, x__xgafv=None)
+  
Returns information about available accelerator topologies for a given MIG.
+
+Args:
+  project: string, Required. Project ID for this request. (required)
+  zone: string, Required. The name of thezone where the managed
+instance group is located.
+Name should conform to RFC1035. (required)
+  resourceId: string, Required. The name of the managed instance group.
+It should conform to RFC1035. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "acceleratorTopologiesInfo": { # The accelerator topology information returned per id of the topology
+      # location.
+    "a_key": {
+      "acceleratorTopology": "A String", # Topology in the format of: "16x16", "4x4x4", etc.
+      "acceleratorTopologyHealth": "A String",
+    },
+  },
+}

+

+
 

     insert(project, zone, body=None, requestId=None, x__xgafv=None)
   
Creates a managed instance group using the information that you specify
@@ -3695,6 +3740,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -4686,6 +4737,12 @@ 
Method Details

             #    About repairing VMs in a MIG.
         "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
           "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+              # Valid values are:
+              #
+              #    - NO (default): MIG cannot change a VM's zone during a
+              #    repair.
+              #    - YES: MIG can select a different zone for the VM during
+              #    a repair.
         },
       },
       "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -6152,6 +6209,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -10546,6 +10609,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html
index c935d36cdd..5d2a13a245 100644
--- a/docs/dyn/compute_beta.instances.html
+++ b/docs/dyn/compute_beta.instances.html
@@ -8793,6 +8793,16 @@ 
Method Details

   An object of the form:
 
     { # A Shielded Instance Identity.
+  "eccP256EncryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the ECC P256 algorithm
+      # issued to the Shielded Instance's vTPM.
+    "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.
+    "ekPub": "A String", # A PEM-encoded public key.
+  },
+  "eccP256SigningKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the ECC P256 algorithm
+      # issued to the Shielded Instance's vTPM.
+    "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.
+    "ekPub": "A String", # A PEM-encoded public key.
+  },
   "encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm
       # issued to the Shielded Instance's vTPM.
     "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.
diff --git a/docs/dyn/compute_beta.interconnectAttachments.html b/docs/dyn/compute_beta.interconnectAttachments.html
index cfa7daea30..8de466eaea 100644
--- a/docs/dyn/compute_beta.interconnectAttachments.html
+++ b/docs/dyn/compute_beta.interconnectAttachments.html
@@ -377,6 +377,72 @@ 
Method Details

             "A String",
           ],
           "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+          "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+              # type is L2_DEDICATED.
+              #
+              # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+              # within L2 packets are mapped to the destination appliances IP addresses.
+              # The packet is then encapsulated with the appliance IP address and sent to
+              # the edge appliance.
+            "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+                # rules. If VLANs are not explicitly mapped to any appliance, the
+                # defaultApplianceIpAddress is used.
+                #
+                # Each VLAN tag can be a single number or a range of numbers in the range
+                # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+                # VLAN tag ranges are enforced, and violating operations will be rejected.
+                #
+                # The VLAN tags in the Ethernet header must use an ethertype value of
+                # 0x88A8 or 0x8100.
+              "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+                "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+                    # address for ingress packets that match on a VLAN tag, but do not match
+                    # a more specific inner VLAN tag.
+                    #
+                    # Unset field (null-value) indicates both VLAN tags are required to be
+                    # mapped. Otherwise, defaultApplianceIpAddress is used.
+                "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+                    # contains two VLAN tags.
+                    #
+                    # A list of mapping rules from inner VLAN tags to IP addresses. If the
+                    # inner VLAN is not explicitly mapped to an IP address range, the
+                    # applianceIpAddress is used.
+                  { # The inner VLAN-to-Appliance mapping.
+                    "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                        # destination IP address for ingress packets that match on both VLAN
+                        # tags.
+                    "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                        # packet. Each entry can be a single number or a range of numbers in
+                        # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                        # and Non-overlapping VLAN tag ranges are enforced, and violating
+                        # operations will be rejected.
+                        #
+                        # The inner VLAN tags must have an ethertype value of 0x8100.
+                      "A String",
+                    ],
+                  },
+                ],
+                "name": "A String", # Optional. The name of this appliance mapping rule.
+              },
+            },
+            "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+                # IP when there is no VLAN mapping result found.
+                #
+                # Unset field (null-value) indicates the unmatched packet should be
+                # dropped.
+            "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+                # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+                # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+                # environments.
+              "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+                  # 16,777,215.
+            },
+            "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+            "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+                # source IP address for packets sent to the appliances, and must be used as
+                # the destination IP address for packets that should be sent out through
+                # this attachment.
+          },
           "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
               # which is essentially a hash of the labels set used for optimistic locking.
               # The fingerprint is initially generated by Compute Engine and changes after
@@ -527,6 +593,8 @@ 
Method Details

               #    customer.
               #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
               #    the partner.
+              #
+              # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
           "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
               # Only specified at creation time.
         },
@@ -1069,6 +1137,72 @@ 
Method Details

     "A String",
   ],
   "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+  "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+      # type is L2_DEDICATED.
+      #
+      # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+      # within L2 packets are mapped to the destination appliances IP addresses.
+      # The packet is then encapsulated with the appliance IP address and sent to
+      # the edge appliance.
+    "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+        # rules. If VLANs are not explicitly mapped to any appliance, the
+        # defaultApplianceIpAddress is used.
+        #
+        # Each VLAN tag can be a single number or a range of numbers in the range
+        # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+        # VLAN tag ranges are enforced, and violating operations will be rejected.
+        #
+        # The VLAN tags in the Ethernet header must use an ethertype value of
+        # 0x88A8 or 0x8100.
+      "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+        "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+            # address for ingress packets that match on a VLAN tag, but do not match
+            # a more specific inner VLAN tag.
+            #
+            # Unset field (null-value) indicates both VLAN tags are required to be
+            # mapped. Otherwise, defaultApplianceIpAddress is used.
+        "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+            # contains two VLAN tags.
+            #
+            # A list of mapping rules from inner VLAN tags to IP addresses. If the
+            # inner VLAN is not explicitly mapped to an IP address range, the
+            # applianceIpAddress is used.
+          { # The inner VLAN-to-Appliance mapping.
+            "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                # destination IP address for ingress packets that match on both VLAN
+                # tags.
+            "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                # packet. Each entry can be a single number or a range of numbers in
+                # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                # and Non-overlapping VLAN tag ranges are enforced, and violating
+                # operations will be rejected.
+                #
+                # The inner VLAN tags must have an ethertype value of 0x8100.
+              "A String",
+            ],
+          },
+        ],
+        "name": "A String", # Optional. The name of this appliance mapping rule.
+      },
+    },
+    "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+        # IP when there is no VLAN mapping result found.
+        #
+        # Unset field (null-value) indicates the unmatched packet should be
+        # dropped.
+    "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+        # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+        # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+        # environments.
+      "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+          # 16,777,215.
+    },
+    "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+    "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+        # source IP address for packets sent to the appliances, and must be used as
+        # the destination IP address for packets that should be sent out through
+        # this attachment.
+  },
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
       # which is essentially a hash of the labels set used for optimistic locking.
       # The fingerprint is initially generated by Compute Engine and changes after
@@ -1219,6 +1353,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      #
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }

@@ -1390,6 +1526,72 @@ 
Method Details

     "A String",
   ],
   "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+  "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+      # type is L2_DEDICATED.
+      # 
+      # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+      # within L2 packets are mapped to the destination appliances IP addresses.
+      # The packet is then encapsulated with the appliance IP address and sent to
+      # the edge appliance.
+    "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+        # rules. If VLANs are not explicitly mapped to any appliance, the
+        # defaultApplianceIpAddress is used.
+        #
+        # Each VLAN tag can be a single number or a range of numbers in the range
+        # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+        # VLAN tag ranges are enforced, and violating operations will be rejected.
+        #
+        # The VLAN tags in the Ethernet header must use an ethertype value of
+        # 0x88A8 or 0x8100.
+      "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+        "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+            # address for ingress packets that match on a VLAN tag, but do not match
+            # a more specific inner VLAN tag.
+            #
+            # Unset field (null-value) indicates both VLAN tags are required to be
+            # mapped. Otherwise, defaultApplianceIpAddress is used.
+        "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+            # contains two VLAN tags.
+            #
+            # A list of mapping rules from inner VLAN tags to IP addresses. If the
+            # inner VLAN is not explicitly mapped to an IP address range, the
+            # applianceIpAddress is used.
+          { # The inner VLAN-to-Appliance mapping.
+            "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                # destination IP address for ingress packets that match on both VLAN
+                # tags.
+            "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                # packet. Each entry can be a single number or a range of numbers in
+                # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                # and Non-overlapping VLAN tag ranges are enforced, and violating
+                # operations will be rejected.
+                #
+                # The inner VLAN tags must have an ethertype value of 0x8100.
+              "A String",
+            ],
+          },
+        ],
+        "name": "A String", # Optional. The name of this appliance mapping rule.
+      },
+    },
+    "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+        # IP when there is no VLAN mapping result found.
+        #
+        # Unset field (null-value) indicates the unmatched packet should be
+        # dropped.
+    "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+        # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+        # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+        # environments.
+      "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+          # 16,777,215.
+    },
+    "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+    "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+        # source IP address for packets sent to the appliances, and must be used as
+        # the destination IP address for packets that should be sent out through
+        # this attachment.
+  },
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
       # which is essentially a hash of the labels set used for optimistic locking.
       # The fingerprint is initially generated by Compute Engine and changes after
@@ -1540,6 +1742,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      # 
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }
@@ -2076,6 +2280,72 @@ 
Method Details

         "A String",
       ],
       "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+      "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+          # type is L2_DEDICATED.
+          #
+          # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+          # within L2 packets are mapped to the destination appliances IP addresses.
+          # The packet is then encapsulated with the appliance IP address and sent to
+          # the edge appliance.
+        "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+            # rules. If VLANs are not explicitly mapped to any appliance, the
+            # defaultApplianceIpAddress is used.
+            #
+            # Each VLAN tag can be a single number or a range of numbers in the range
+            # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+            # VLAN tag ranges are enforced, and violating operations will be rejected.
+            #
+            # The VLAN tags in the Ethernet header must use an ethertype value of
+            # 0x88A8 or 0x8100.
+          "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+            "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+                # address for ingress packets that match on a VLAN tag, but do not match
+                # a more specific inner VLAN tag.
+                #
+                # Unset field (null-value) indicates both VLAN tags are required to be
+                # mapped. Otherwise, defaultApplianceIpAddress is used.
+            "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+                # contains two VLAN tags.
+                #
+                # A list of mapping rules from inner VLAN tags to IP addresses. If the
+                # inner VLAN is not explicitly mapped to an IP address range, the
+                # applianceIpAddress is used.
+              { # The inner VLAN-to-Appliance mapping.
+                "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                    # destination IP address for ingress packets that match on both VLAN
+                    # tags.
+                "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                    # packet. Each entry can be a single number or a range of numbers in
+                    # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                    # and Non-overlapping VLAN tag ranges are enforced, and violating
+                    # operations will be rejected.
+                    #
+                    # The inner VLAN tags must have an ethertype value of 0x8100.
+                  "A String",
+                ],
+              },
+            ],
+            "name": "A String", # Optional. The name of this appliance mapping rule.
+          },
+        },
+        "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+            # IP when there is no VLAN mapping result found.
+            #
+            # Unset field (null-value) indicates the unmatched packet should be
+            # dropped.
+        "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+            # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+            # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+            # environments.
+          "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+              # 16,777,215.
+        },
+        "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+        "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+            # source IP address for packets sent to the appliances, and must be used as
+            # the destination IP address for packets that should be sent out through
+            # this attachment.
+      },
       "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
           # which is essentially a hash of the labels set used for optimistic locking.
           # The fingerprint is initially generated by Compute Engine and changes after
@@ -2226,6 +2496,8 @@ 
Method Details

           #    customer.
           #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
           #    the partner.
+          #
+          # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
       "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
           # Only specified at creation time.
     },
@@ -2449,6 +2721,72 @@ 
Method Details

     "A String",
   ],
   "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+  "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+      # type is L2_DEDICATED.
+      # 
+      # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+      # within L2 packets are mapped to the destination appliances IP addresses.
+      # The packet is then encapsulated with the appliance IP address and sent to
+      # the edge appliance.
+    "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+        # rules. If VLANs are not explicitly mapped to any appliance, the
+        # defaultApplianceIpAddress is used.
+        #
+        # Each VLAN tag can be a single number or a range of numbers in the range
+        # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+        # VLAN tag ranges are enforced, and violating operations will be rejected.
+        #
+        # The VLAN tags in the Ethernet header must use an ethertype value of
+        # 0x88A8 or 0x8100.
+      "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+        "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+            # address for ingress packets that match on a VLAN tag, but do not match
+            # a more specific inner VLAN tag.
+            #
+            # Unset field (null-value) indicates both VLAN tags are required to be
+            # mapped. Otherwise, defaultApplianceIpAddress is used.
+        "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+            # contains two VLAN tags.
+            #
+            # A list of mapping rules from inner VLAN tags to IP addresses. If the
+            # inner VLAN is not explicitly mapped to an IP address range, the
+            # applianceIpAddress is used.
+          { # The inner VLAN-to-Appliance mapping.
+            "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                # destination IP address for ingress packets that match on both VLAN
+                # tags.
+            "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                # packet. Each entry can be a single number or a range of numbers in
+                # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                # and Non-overlapping VLAN tag ranges are enforced, and violating
+                # operations will be rejected.
+                #
+                # The inner VLAN tags must have an ethertype value of 0x8100.
+              "A String",
+            ],
+          },
+        ],
+        "name": "A String", # Optional. The name of this appliance mapping rule.
+      },
+    },
+    "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+        # IP when there is no VLAN mapping result found.
+        #
+        # Unset field (null-value) indicates the unmatched packet should be
+        # dropped.
+    "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+        # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+        # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+        # environments.
+      "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+          # 16,777,215.
+    },
+    "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+    "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+        # source IP address for packets sent to the appliances, and must be used as
+        # the destination IP address for packets that should be sent out through
+        # this attachment.
+  },
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
       # which is essentially a hash of the labels set used for optimistic locking.
       # The fingerprint is initially generated by Compute Engine and changes after
@@ -2599,6 +2937,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      # 
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }
diff --git a/docs/dyn/compute_beta.interconnectGroups.html b/docs/dyn/compute_beta.interconnectGroups.html
index 0cb4a13028..4b52ec3e39 100644
--- a/docs/dyn/compute_beta.interconnectGroups.html
+++ b/docs/dyn/compute_beta.interconnectGroups.html
@@ -864,7 +864,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
@@ -1556,7 +1556,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
@@ -2039,7 +2039,7 @@ 
Method Details

           # If provided when patching a configuration in update mode, the provided
           # token must match the current token or the update is rejected. This provides
           # a reliable means of doing read-modify-write (optimistic locking) as
-          # described byAPI 154.
+          # described by AIP 154.
       "id": "A String", # [Output Only] The unique identifier for the resource type. The server
           # generates this identifier.
       "intent": { # The user's intent for this group. This is the only required field besides
@@ -2213,7 +2213,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
diff --git a/docs/dyn/compute_beta.interconnectLocations.html b/docs/dyn/compute_beta.interconnectLocations.html
index cf1d8fd838..98684aef91 100644
--- a/docs/dyn/compute_beta.interconnectLocations.html
+++ b/docs/dyn/compute_beta.interconnectLocations.html
@@ -175,6 +175,8 @@ 
Method Details

         # Region.
       "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation
           # to a VM in this region.
+      "l2ForwardingEnabled": True or False, # Identifies whether L2 Interconnect Attachments can be created in this
+          # region for interconnects that are in this location.
       "locationPresence": "A String", # Identifies the network presence of this location.
       "region": "A String", # URL for the region of this location.
     },
@@ -364,6 +366,8 @@ 
Method Details

             # Region.
           "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation
               # to a VM in this region.
+          "l2ForwardingEnabled": True or False, # Identifies whether L2 Interconnect Attachments can be created in this
+              # region for interconnects that are in this location.
           "locationPresence": "A String", # Identifies the network presence of this location.
           "region": "A String", # URL for the region of this location.
         },
diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html
index b56eb9ceeb..65581260c0 100644
--- a/docs/dyn/compute_beta.networkFirewallPolicies.html
+++ b/docs/dyn/compute_beta.networkFirewallPolicies.html
@@ -1372,7 +1372,7 @@ 
Method Details

 firewall policies from all applicable scopes (global and regional) and
 grouping the results per scope.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.networkProfiles.html b/docs/dyn/compute_beta.networkProfiles.html
index f5ab98d27a..1df5138bbb 100644
--- a/docs/dyn/compute_beta.networkProfiles.html
+++ b/docs/dyn/compute_beta.networkProfiles.html
@@ -130,6 +130,7 @@ 
Method Details

     "allowIpForwarding": "A String", # Specifies whether IP forwarding is allowed.
     "allowLoadBalancing": "A String", # Specifies whether cloud load balancing is allowed.
     "allowMultiNicInSameNetwork": "A String", # Specifies whether multi-nic in the same network is allowed.
+    "allowMulticast": "A String", # Specifies whether multicast is allowed.
     "allowNcc": "A String", # Specifies whether NCC is allowed.
     "allowNetworkMigration": "A String", # Specifies whether VM network migration is allowed.
     "allowPacketMirroring": "A String", # Specifies whether Packet Mirroring 1.0 is supported.
@@ -147,6 +148,7 @@ 
Method Details

         # empty, all interface types are supported.
       "A String",
     ],
+    "multicast": "A String", # Specifies which type of multicast is supported.
     "subnetPurposes": [ # Specifies which subnetwork purposes are supported.
       "A String",
     ],
@@ -305,6 +307,7 @@ 
Method Details

         "allowIpForwarding": "A String", # Specifies whether IP forwarding is allowed.
         "allowLoadBalancing": "A String", # Specifies whether cloud load balancing is allowed.
         "allowMultiNicInSameNetwork": "A String", # Specifies whether multi-nic in the same network is allowed.
+        "allowMulticast": "A String", # Specifies whether multicast is allowed.
         "allowNcc": "A String", # Specifies whether NCC is allowed.
         "allowNetworkMigration": "A String", # Specifies whether VM network migration is allowed.
         "allowPacketMirroring": "A String", # Specifies whether Packet Mirroring 1.0 is supported.
@@ -322,6 +325,7 @@ 
Method Details

             # empty, all interface types are supported.
           "A String",
         ],
+        "multicast": "A String", # Specifies which type of multicast is supported.
         "subnetPurposes": [ # Specifies which subnetwork purposes are supported.
           "A String",
         ],
diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html
index 49509ede63..f2ea6b6cf7 100644
--- a/docs/dyn/compute_beta.projects.html
+++ b/docs/dyn/compute_beta.projects.html
@@ -109,7 +109,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   moveDisk(project, body=None, requestId=None, x__xgafv=None)

-
Starting September 29, 2025, you can't use the moveDisk API on new

+
Moves a persistent disk from one zone to another.

 

   moveInstance(project, body=None, requestId=None, x__xgafv=None)

 
Moves an instance and its attached persistent disks from one zone to

@@ -1873,10 +1873,13 @@ 
Method Details

 
 

     moveDisk(project, body=None, requestId=None, x__xgafv=None)
-  
Starting September 29, 2025, you can't use the moveDisk API on new
+  
Moves a persistent disk from one zone to another.
+*Note*: The moveDisk API will be deprecated on September 29, 2026.
+
+Starting September 29, 2025, you can't use the moveDisk API on new
 projects. To move a disk to a different region or zone, follow the steps in
 [Change the location of a
-disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
+disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
 
 Projects that already use the moveDisk API can continue usage until
 September 29, 2026.
diff --git a/docs/dyn/compute_beta.regionBackendBuckets.html b/docs/dyn/compute_beta.regionBackendBuckets.html
index 2264ac8114..e2e3201daa 100644
--- a/docs/dyn/compute_beta.regionBackendBuckets.html
+++ b/docs/dyn/compute_beta.regionBackendBuckets.html
@@ -517,7 +517,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -596,6 +596,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
@@ -1086,7 +1090,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1165,6 +1169,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
@@ -1649,7 +1657,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1728,6 +1736,10 @@ 
Method Details

           "a_key": "A String",
         },
       },
+      "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+          # resides. This field is not applicable to global backend buckets.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
         {
@@ -1975,7 +1987,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2054,6 +2066,10 @@ 
Method Details

           "a_key": "A String",
         },
       },
+      "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+          # resides. This field is not applicable to global backend buckets.
+          # You must specify this field as part of the HTTP request URL. It is
+          # not settable as a field in the request body.
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
       "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
         {
@@ -2241,7 +2257,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2320,6 +2336,10 @@ 
Method Details

       "a_key": "A String",
     },
   },
+  "region": "A String", # [Output Only] URL of the region where the regional backend bucket
+      # resides. This field is not applicable to global backend buckets.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
   "usedBy": [ # [Output Only] List of resources referencing that backend bucket.
     {
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
index c75e600130..fd265f5fd3 100644
--- a/docs/dyn/compute_beta.regionBackendServices.html
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -485,7 +485,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -681,7 +682,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -873,7 +874,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -1675,6 +1677,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
@@ -2209,7 +2249,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -2405,7 +2446,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2597,7 +2638,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -3399,6 +3441,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
@@ -3870,7 +3950,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -4066,7 +4147,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -4258,7 +4339,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -5060,6 +5142,44 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+            #
+            #
+            # Use this property to configure the load balancer back-end to use
+            # certificates and roots of trust provisioned by the Managed Workload
+            # Identity system.
+            #
+            #  The `identity` property is the
+            # fully-specified SPIFFE ID to use in the SVID presented by the Load
+            # Balancer Workload.
+            #
+            #  The SPIFFE ID must be a resource starting with the
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
+            #
+            #  Supported SPIFFE ID format:
+            #
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+            #
+            #
+            # The Trust Domain within the Managed Identity must refer to a valid
+            # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+            # will be inherited from the Workload Identity Pool.
+            #
+            #  Restrictions:
+            #
+            #    - If you set the `identity` property, you cannot manually set
+            #    the following fields:
+            #        - tlsSettings.sni
+            #       - tlsSettings.subjectAltNames
+            #       - tlsSettings.authenticationConfig
+            #
+            #
+            # When defining a `identity` for a RegionBackendServices, the
+            # corresponding Workload Identity Pool must have a ca_pool
+            # configured in the same region.
+            #
+            #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
         "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
             # balancer sends this string as the SNI hostname in the TLS connection to
             # the backend, and requires that this string match a Subject Alternative
@@ -5294,7 +5414,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -5490,7 +5611,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -5682,7 +5803,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -6484,6 +6606,44 @@ 
Method Details

             # networksecurity.googleapis.com namespace. Can be used in authenticating
             # TLS connections to the backend, as specified by the authenticationMode
             # field. Can only be specified if authenticationMode is not NONE.
+        "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+            #
+            #
+            # Use this property to configure the load balancer back-end to use
+            # certificates and roots of trust provisioned by the Managed Workload
+            # Identity system.
+            #
+            #  The `identity` property is the
+            # fully-specified SPIFFE ID to use in the SVID presented by the Load
+            # Balancer Workload.
+            #
+            #  The SPIFFE ID must be a resource starting with the
+            # `trustDomain` property value, followed by the path to the Managed
+            # Workload Identity.
+            #
+            #  Supported SPIFFE ID format:
+            #
+            #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+            #
+            #
+            # The Trust Domain within the Managed Identity must refer to a valid
+            # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+            # will be inherited from the Workload Identity Pool.
+            #
+            #  Restrictions:
+            #
+            #    - If you set the `identity` property, you cannot manually set
+            #    the following fields:
+            #        - tlsSettings.sni
+            #       - tlsSettings.subjectAltNames
+            #       - tlsSettings.authenticationConfig
+            #
+            #
+            # When defining a `identity` for a RegionBackendServices, the
+            # corresponding Workload Identity Pool must have a ca_pool
+            # configured in the same region.
+            #
+            #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
         "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
             # balancer sends this string as the SNI hostname in the TLS connection to
             # the backend, and requires that this string match a Subject Alternative
@@ -6659,7 +6819,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -6855,7 +7016,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -7047,7 +7208,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -7849,6 +8011,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
@@ -9432,7 +9632,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -9628,7 +9829,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -9820,7 +10021,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -10622,6 +10824,44 @@ 
Method Details

         # networksecurity.googleapis.com namespace. Can be used in authenticating
         # TLS connections to the backend, as specified by the authenticationMode
         # field. Can only be specified if authenticationMode is not NONE.
+    "identity": "A String", # Assigns the Managed Identity for the BackendService Workload.
+        #
+        #
+        # Use this property to configure the load balancer back-end to use
+        # certificates and roots of trust provisioned by the Managed Workload
+        # Identity system.
+        #
+        #  The `identity` property is the
+        # fully-specified SPIFFE ID to use in the SVID presented by the Load
+        # Balancer Workload.
+        #
+        #  The SPIFFE ID must be a resource starting with the
+        # `trustDomain` property value, followed by the path to the Managed
+        # Workload Identity.
+        #
+        #  Supported SPIFFE ID format:
+        #
+        #    - //<trust_domain>/ns/<namespace>/sa/<subject>
+        #
+        #
+        # The Trust Domain within the Managed Identity must refer to a valid
+        # Workload Identity Pool. The TrustConfig and CertificateIssuanceConfig
+        # will be inherited from the Workload Identity Pool.
+        #
+        #  Restrictions:
+        #
+        #    - If you set the `identity` property, you cannot manually set
+        #    the following fields:
+        #        - tlsSettings.sni
+        #       - tlsSettings.subjectAltNames
+        #       - tlsSettings.authenticationConfig
+        #
+        #
+        # When defining a `identity` for a RegionBackendServices, the
+        # corresponding Workload Identity Pool must have a ca_pool
+        # configured in the same region.
+        #
+        #  The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.
     "sni": "A String", # Server Name Indication - see RFC3546 section 3.1. If set, the load
         # balancer sends this string as the SNI hostname in the TLS connection to
         # the backend, and requires that this string match a Subject Alternative
diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html
index f9ee476f43..278e566eb8 100644
--- a/docs/dyn/compute_beta.regionCommitments.html
+++ b/docs/dyn/compute_beta.regionCommitments.html
@@ -109,7 +109,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of commitments by region.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.regionCompositeHealthChecks.html b/docs/dyn/compute_beta.regionCompositeHealthChecks.html
index 99db78d8d4..426067cfbc 100644
--- a/docs/dyn/compute_beta.regionCompositeHealthChecks.html
+++ b/docs/dyn/compute_beta.regionCompositeHealthChecks.html
@@ -110,7 +110,7 @@ 
Method Details

   
Retrieves the list of all CompositeHealthCheck resources (all
 regional) available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -298,6 +298,9 @@ 
Method Details

       # Subsequent list requests will have their own nextPageToken to
       # continue paging through the results.
   "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
   "warning": { # [Output Only] Informational warning message.
     "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
         # Engine returns NO_RESULTS_ON_PAGE if there
diff --git a/docs/dyn/compute_beta.regionHealthAggregationPolicies.html b/docs/dyn/compute_beta.regionHealthAggregationPolicies.html
index 5e9fcbf401..8ad1d78987 100644
--- a/docs/dyn/compute_beta.regionHealthAggregationPolicies.html
+++ b/docs/dyn/compute_beta.regionHealthAggregationPolicies.html
@@ -110,7 +110,7 @@ 
Method Details

   
Retrieves the list of all HealthAggregationPolicy resources,
 regional and global, available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.regionHealthSources.html b/docs/dyn/compute_beta.regionHealthSources.html
index d4b2ee8876..699005dccf 100644
--- a/docs/dyn/compute_beta.regionHealthSources.html
+++ b/docs/dyn/compute_beta.regionHealthSources.html
@@ -301,6 +301,9 @@ 
Method Details

       # Subsequent list requests will have their own nextPageToken to
       # continue paging through the results.
   "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
   "warning": { # [Output Only] Informational warning message.
     "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
         # Engine returns NO_RESULTS_ON_PAGE if there
diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
index b99710d852..509f31f12a 100644
--- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html
@@ -2228,6 +2228,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -2862,6 +2868,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -3852,6 +3864,12 @@ 
Method Details

             #    About repairing VMs in a MIG.
         "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
           "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+              # Valid values are:
+              #
+              #    - NO (default): MIG cannot change a VM's zone during a
+              #    repair.
+              #    - YES: MIG can select a different zone for the VM during
+              #    a repair.
         },
       },
       "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -5310,6 +5328,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
@@ -9670,6 +9694,12 @@ 
Method Details

         #    About repairing VMs in a MIG.
     "onRepair": { # Configuration for VM repairs in the MIG. # Configuration for VM repairs in the MIG.
       "allowChangingZone": "A String", # Specifies whether the MIG can change a VM's zone during a repair.
+          # Valid values are:
+          #
+          #    - NO (default): MIG cannot change a VM's zone during a
+          #    repair.
+          #    - YES: MIG can select a different zone for the VM during
+          #    a repair.
     },
   },
   "instanceTemplate": "A String", # The URL of the instance template that is specified for this managed
diff --git a/docs/dyn/compute_beta.reservationSubBlocks.html b/docs/dyn/compute_beta.reservationSubBlocks.html
index 56d7082195..fe109cc919 100644
--- a/docs/dyn/compute_beta.reservationSubBlocks.html
+++ b/docs/dyn/compute_beta.reservationSubBlocks.html
@@ -78,7 +78,7 @@ 
Instance Methods

   close()

 
Close httplib2 connections.

 

-  get(project, zone, parentName, reservationSubBlock, x__xgafv=None)

+  get(project, zone, parentName, reservationSubBlock, view=None, x__xgafv=None)

 
Retrieves information about the specified reservation subBlock.

 

   getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

@@ -108,7 +108,7 @@ 
Method Details

 

 
 

-    get(project, zone, parentName, reservationSubBlock, x__xgafv=None)
+    get(project, zone, parentName, reservationSubBlock, view=None, x__xgafv=None)
   
Retrieves information about the specified reservation subBlock.
 
 Args:
@@ -118,6 +118,11 @@ 
Method Details

 reservations/{reservation_name}/reservationBlocks/{reservation_block_name} (required)
   reservationSubBlock: string, The name of the reservation subBlock.
 Name should conform to RFC1035 or be a resource ID. (required)
+  view: string, View of the subBlock.
+    Allowed values
+      SUB_BLOCK_VIEW_BASIC - This view includes basic information about the reservation sub block
+      SUB_BLOCK_VIEW_FULL - Includes detailed topology view.
+      SUB_BLOCK_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -128,6 +133,19 @@ 
Method Details

 
     {
   "resource": { # Represents a reservation subBlock resource.
+    "acceleratorTopologiesInfo": { # Info for accelerator topologies within a densely packed reservation. # [Output Only] Slice info for the reservation subBlock.
+      "acceleratorTopologyInfos": [ # Info for each accelerator topology.
+        { # Info for a slice of a given topology.
+          "acceleratorTopology": "A String", # The accelerator topology.
+          "infoPerTopologyStates": [ # Info for each topology state.
+            { # Info for each topology state.
+              "count": 42, # The number of accelerator topologies in this state.
+              "state": "A String", # The state of the accelerator topology.
+            },
+          ],
+        },
+      ],
+    },
     "count": 42, # [Output Only] The number of hosts that are allocated in this
         # reservation subBlock.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format.
@@ -669,6 +687,19 @@ 
Method Details

   "id": "A String", # Unique identifier for the resource; defined by the server.
   "items": [ # A list of reservation subBlock resources.
     { # Represents a reservation subBlock resource.
+      "acceleratorTopologiesInfo": { # Info for accelerator topologies within a densely packed reservation. # [Output Only] Slice info for the reservation subBlock.
+        "acceleratorTopologyInfos": [ # Info for each accelerator topology.
+          { # Info for a slice of a given topology.
+            "acceleratorTopology": "A String", # The accelerator topology.
+            "infoPerTopologyStates": [ # Info for each topology state.
+              { # Info for each topology state.
+                "count": 42, # The number of accelerator topologies in this state.
+                "state": "A String", # The state of the accelerator topology.
+              },
+            ],
+          },
+        ],
+      },
       "count": 42, # [Output Only] The number of hosts that are allocated in this
           # reservation subBlock.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format.
diff --git a/docs/dyn/compute_beta.reservations.html b/docs/dyn/compute_beta.reservations.html
index f9e4876c5c..73355f107b 100644
--- a/docs/dyn/compute_beta.reservations.html
+++ b/docs/dyn/compute_beta.reservations.html
@@ -121,7 +121,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of reservations.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_beta.resourcePolicies.html b/docs/dyn/compute_beta.resourcePolicies.html
index 8996193f4a..1d677173b6 100644
--- a/docs/dyn/compute_beta.resourcePolicies.html
+++ b/docs/dyn/compute_beta.resourcePolicies.html
@@ -237,6 +237,8 @@ 
Method Details

           },
           "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
               # It specifies the failure bucket separation
+            "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+                # specified, the default is AUTO_CONNECT.
             "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
                 # instances are in different availability domain, they are not in the same
                 # low latency network.
@@ -753,6 +755,8 @@ 
Method Details

   },
   "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
       # It specifies the failure bucket separation
+    "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+        # specified, the default is AUTO_CONNECT.
     "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
         # instances are in different availability domain, they are not in the same
         # low latency network.
@@ -1267,6 +1271,8 @@ 
Method Details

   },
   "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
       # It specifies the failure bucket separation
+    "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+        # specified, the default is AUTO_CONNECT.
     "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
         # instances are in different availability domain, they are not in the same
         # low latency network.
@@ -1778,6 +1784,8 @@ 
Method Details

       },
       "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
           # It specifies the failure bucket separation
+        "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+            # specified, the default is AUTO_CONNECT.
         "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
             # instances are in different availability domain, they are not in the same
             # low latency network.
@@ -1972,6 +1980,8 @@ 
Method Details

   },
   "groupPlacementPolicy": { # A GroupPlacementPolicy specifies resource placement configuration. # Resource policy for instances for placement configuration.
       # It specifies the failure bucket separation
+    "acceleratorTopologyMode": "A String", # Specifies the connection mode for the accelerator topology. If not
+        # specified, the default is AUTO_CONNECT.
     "availabilityDomainCount": 42, # The number of availability domains to spread instances across. If two
         # instances are in different availability domain, they are not in the same
         # low latency network.
diff --git a/docs/dyn/compute_beta.routers.html b/docs/dyn/compute_beta.routers.html
index d468cd0eee..a16ec62c3e 100644
--- a/docs/dyn/compute_beta.routers.html
+++ b/docs/dyn/compute_beta.routers.html
@@ -2477,7 +2477,9 @@ 
Method Details

             # cases where multiple routes have equal prefix length, the one with the
             # lowest-numbered priority value wins. The default value is `1000`. The
             # priority value must be from `0` to `65535`, inclusive.
-        "routeStatus": "A String", # [Output only] The status of the route.
+        "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+            # dynamic routes learned by Cloud Routers. This status is not applicable
+            # to static routes.
         "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
             # values:
             # - 'TRANSIT' for a transit route that this router learned from
@@ -2645,7 +2647,9 @@ 
Method Details

             # cases where multiple routes have equal prefix length, the one with the
             # lowest-numbered priority value wins. The default value is `1000`. The
             # priority value must be from `0` to `65535`, inclusive.
-        "routeStatus": "A String", # [Output only] The status of the route.
+        "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+            # dynamic routes learned by Cloud Routers. This status is not applicable
+            # to static routes.
         "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
             # values:
             # - 'TRANSIT' for a transit route that this router learned from
@@ -2811,7 +2815,9 @@ 
Method Details

                 # cases where multiple routes have equal prefix length, the one with the
                 # lowest-numbered priority value wins. The default value is `1000`. The
                 # priority value must be from `0` to `65535`, inclusive.
-            "routeStatus": "A String", # [Output only] The status of the route.
+            "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+                # dynamic routes learned by Cloud Routers. This status is not applicable
+                # to static routes.
             "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
                 # values:
                 # - 'TRANSIT' for a transit route that this router learned from
diff --git a/docs/dyn/compute_beta.routes.html b/docs/dyn/compute_beta.routes.html
index 26ab82b8c7..23652d9578 100644
--- a/docs/dyn/compute_beta.routes.html
+++ b/docs/dyn/compute_beta.routes.html
@@ -517,7 +517,9 @@ 
Method Details

       # cases where multiple routes have equal prefix length, the one with the
       # lowest-numbered priority value wins. The default value is `1000`. The
       # priority value must be from `0` to `65535`, inclusive.
-  "routeStatus": "A String", # [Output only] The status of the route.
+  "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+      # dynamic routes learned by Cloud Routers. This status is not applicable
+      # to static routes.
   "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
       # values:
       # - 'TRANSIT' for a transit route that this router learned from
@@ -691,7 +693,9 @@ 
Method Details

       # cases where multiple routes have equal prefix length, the one with the
       # lowest-numbered priority value wins. The default value is `1000`. The
       # priority value must be from `0` to `65535`, inclusive.
-  "routeStatus": "A String", # [Output only] The status of the route.
+  "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+      # dynamic routes learned by Cloud Routers. This status is not applicable
+      # to static routes.
   "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
       # values:
       # - 'TRANSIT' for a transit route that this router learned from
@@ -1227,7 +1231,9 @@ 
Method Details

           # cases where multiple routes have equal prefix length, the one with the
           # lowest-numbered priority value wins. The default value is `1000`. The
           # priority value must be from `0` to `65535`, inclusive.
-      "routeStatus": "A String", # [Output only] The status of the route.
+      "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+          # dynamic routes learned by Cloud Routers. This status is not applicable
+          # to static routes.
       "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
           # values:
           # - 'TRANSIT' for a transit route that this router learned from
diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html
index 8fea50952a..223141ea37 100644
--- a/docs/dyn/compute_beta.subnetworks.html
+++ b/docs/dyn/compute_beta.subnetworks.html
@@ -75,7 +75,7 @@
 
Compute Engine API . subnetworks

 
Instance Methods

 

-  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)

 
Retrieves an aggregated list of subnetworks.

 

   aggregatedList_next()

@@ -124,7 +124,7 @@ 
Instance Methods

 
Returns permissions that a caller has on the specified resource.

 
Method Details

 

-    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)
   
Retrieves an aggregated list of subnetworks.
 
 To prevent failure, Google recommends that you set the
@@ -224,6 +224,14 @@ 
Method Details

 with an error code.
   serviceProjectNumber: string, The Shared VPC service project id or service project number for which
 aggregated list request is invoked for subnetworks list-usable api.
+  views: string, Defines the extra views returned back in the subnetwork resource.
+Supported values:
+   
+   - WITH_UTILIZATION: Utilization data is included in the
+   response. (repeated)
+    Allowed values
+      DEFAULT - 
+      WITH_UTILIZATION - Utilization data is included in the response.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/compute_beta.zoneVmExtensionPolicies.html b/docs/dyn/compute_beta.zoneVmExtensionPolicies.html
new file mode 100644
index 0000000000..938f585298
--- /dev/null
+++ b/docs/dyn/compute_beta.zoneVmExtensionPolicies.html
@@ -0,0 +1,1365 @@
+
+
+
+
Compute Engine API . zoneVmExtensionPolicies

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  delete(project, zone, vmExtensionPolicy, requestId=None, x__xgafv=None)

+
Deletes a specified zone VM extension policy.

+

+  get(project, zone, vmExtensionPolicy, x__xgafv=None)

+
Retrieves details of a specific zone VM extension policy.

+

+  insert(project, zone, body=None, requestId=None, x__xgafv=None)

+
Creates a new zone-level VM extension policy within a project.

+

+  list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+
Lists all VM extension policies within a specific zone for a project.

+

+  list_next()

+
Retrieves the next page of results.

+

+  update(project, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None)

+
Modifies an existing zone VM extension policy.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    delete(project, zone, vmExtensionPolicy, requestId=None, x__xgafv=None)
+  
Deletes a specified zone VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+

+    get(project, zone, vmExtensionPolicy, x__xgafv=None)
+  
Retrieves details of a specific zone VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the VM extension policy resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a VM extension policy.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
+      # configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the more recent creation timestamp takes precedence.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
+      # text format.
+}

+

+
+

+    insert(project, zone, body=None, requestId=None, x__xgafv=None)
+  
Creates a new zone-level VM extension policy within a project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
+      # configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the more recent creation timestamp takes precedence.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+

+    list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Lists all VM extension policies within a specific zone for a project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # [Output Only] Fingerprint of this resource. A hash of the contents stored
+      # in this object. This field is used in optimistic locking. This field will
+      # be ignored when inserting a VmExtensionPolicy. An up-to-date
+      # fingerprint must be provided in order to update the VmExtensionPolicy.
+      #
+      # To see the latest value of the fingerprint, make a get() request to
+      # retrieve a VmExtensionPolicy.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # [Output Only] A list of VM extension policy resources.
+    { # Represents a VM extension policy.
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource.
+      "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
+          # configurations.
+        "a_key": { # Configuration for a specific VM extension.
+          "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+              # version is used.
+          "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+        },
+      },
+      "globalResourceLink": "A String", # Optional. [Output Only] Link to the global policy that manages this zone policy, if
+          # applicable.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+          # *any* of the provided selectors (logical OR). If this list is empty, the
+          # policy applies to all VMs.
+        { # Defines how to select VMs to apply a zone VM extension policy.
+          "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+              # labels.
+            "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+                # VMs must have all of the labels specified in this map to be selected
+                # (logical AND).
+                #
+                # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+                # "value2")}, the VM labels must contain both ("key1", "value1") and
+                # ("key2", "value2") to be selected. If the VM labels are ("key1",
+                # "value1") and ("something", "else"), it will not be selected.
+                #
+                # If the map is empty, it's considered a match.
+              "a_key": "A String",
+            },
+          },
+        },
+      ],
+      "kind": "compute#vmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+      "managedByGlobal": True or False, # Optional. [Output Only] Indicates if this policy is managed by a global policy.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+          # which means the first character must be a lowercase letter, and all
+          # following characters must be a dash, lowercase letter, or digit, except
+          # the last character, which cannot be a dash.
+      "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+          # apply to the same extension.
+          # The policy priority is an integer from 0 to 65535, inclusive. Lower
+          # integers indicate higher priorities. If you do not specify a priority when
+          # creating a rule, it is assigned a priority of 1000. If priorities are
+          # equal, the policy with the more recent creation timestamp takes precedence.
+      "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "state": "A String", # Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.
+      "updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
+          # text format.
+    },
+  ],
+  "kind": "compute#vmExtensionPolicyList", # Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources.
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    update(project, zone, vmExtensionPolicy, body=None, requestId=None, x__xgafv=None)
+  
Modifies an existing zone VM extension policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  vmExtensionPolicy: string, Name of the zone VM extension policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a VM extension policy.
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource.
+  "extensionPolicies": { # Required. A map of extension names (e.g., "cloudops") to their corresponding policy
+      # configurations.
+    "a_key": { # Configuration for a specific VM extension.
+      "pinnedVersion": "A String", # Optional. The specific version of the extension to install. If not set, the latest
+          # version is used.
+      "stringConfig": "A String", # Optional. String-based configuration data for the extension.
+    },
+  },
+  "globalResourceLink": "A String", # Optional. [Output Only] Link to the global policy that manages this zone policy, if
+      # applicable.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "instanceSelectors": [ # Optional. Selectors to target VMs for this policy. VMs are selected if they match
+      # *any* of the provided selectors (logical OR). If this list is empty, the
+      # policy applies to all VMs.
+    { # Defines how to select VMs to apply a zone VM extension policy.
+      "labelSelector": { # A LabelSelector is applied to a VM only if it matches all the specified # Optional. LabelSelector selects VMs based on their labels.
+          # labels.
+        "inclusionLabels": { # Optional. A map of key-value pairs representing VM labels.
+            # VMs must have all of the labels specified in this map to be selected
+            # (logical AND).
+            #
+            # e.g. If the `inclusion_labels` are {("key1", "value1"), ("key2",
+            # "value2")}, the VM labels must contain both ("key1", "value1") and
+            # ("key2", "value2") to be selected. If the VM labels are ("key1",
+            # "value1") and ("something", "else"), it will not be selected.
+            #
+            # If the map is empty, it's considered a match.
+          "a_key": "A String",
+        },
+      },
+    },
+  ],
+  "kind": "compute#vmExtensionPolicy", # [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.
+  "managedByGlobal": True or False, # Optional. [Output Only] Indicates if this policy is managed by a global policy.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?`
+      # which means the first character must be a lowercase letter, and all
+      # following characters must be a dash, lowercase letter, or digit, except
+      # the last character, which cannot be a dash.
+  "priority": 42, # Optional. Priority of this policy. Used to resolve conflicts when multiple policies
+      # apply to the same extension.
+      # The policy priority is an integer from 0 to 65535, inclusive. Lower
+      # integers indicate higher priorities. If you do not specify a priority when
+      # creating a rule, it is assigned a priority of 1000. If priorities are
+      # equal, the policy with the more recent creation timestamp takes precedence.
+  "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "state": "A String", # Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.
+  "updateTimestamp": "A String", # [Output Only] Update timestamp inRFC3339
+      # text format.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/beta/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/beta/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/beta/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [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.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # different programming environments, including REST APIs and RPC APIs. It is
+            # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+            # three pieces of data: error code, error message, and error details.
+            #
+            # You can find out more about this error model and how to work with it in the
+            # [API Design Guide](https://cloud.google.com/apis/design/errors).
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details.  There is a common set of
+              # message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any
+              # user-facing error message should be localized and sent in the
+              # google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/compute_v1.acceleratorTypes.html b/docs/dyn/compute_v1.acceleratorTypes.html
index aef551c0cb..1ad903f41a 100644
--- a/docs/dyn/compute_v1.acceleratorTypes.html
+++ b/docs/dyn/compute_v1.acceleratorTypes.html
@@ -97,7 +97,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of accelerator types.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html
index 1d89a240d5..03e569b98e 100644
--- a/docs/dyn/compute_v1.addresses.html
+++ b/docs/dyn/compute_v1.addresses.html
@@ -112,7 +112,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of addresses.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.autoscalers.html b/docs/dyn/compute_v1.autoscalers.html
index 5602a30fc9..a47e03c2b9 100644
--- a/docs/dyn/compute_v1.autoscalers.html
+++ b/docs/dyn/compute_v1.autoscalers.html
@@ -109,7 +109,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of autoscalers.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.backendBuckets.html b/docs/dyn/compute_v1.backendBuckets.html
index cae01873d8..961c9300a4 100644
--- a/docs/dyn/compute_v1.backendBuckets.html
+++ b/docs/dyn/compute_v1.backendBuckets.html
@@ -1096,7 +1096,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -1663,7 +1663,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2225,7 +2225,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2475,7 +2475,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -4142,7 +4142,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html
index 7eb5ba9c3f..9cbe93ff89 100644
--- a/docs/dyn/compute_v1.backendServices.html
+++ b/docs/dyn/compute_v1.backendServices.html
@@ -439,7 +439,7 @@ 
Method Details

   
Retrieves the list of all BackendService resources, regional and global,
 available to the specified project.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -612,7 +612,8 @@ 
Method Details

                   "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                       # balancing mode. The valid range is [0.0, 1.0].
                   "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                      # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                      # long and match the regular expression
+                      # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                       # first character must be a lowercase letter, and all following
                       # characters must be a dash, period, underscore, lowercase letter, or
                       # digit, except the last character, which cannot be a dash, period, or
@@ -799,7 +800,7 @@ 
Method Details

                 # negative caching when a policy exists.
               { # Specify CDN TTLs for response error codes.
                 "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                    # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                     # specified as values, and you cannot specify a status code more than
                     # once.
                 "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -979,7 +980,8 @@ 
Method Details

                 # locality_lb_policy.
               "dryRun": True or False, # If true, the metric data is not used for load balancing.
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -2480,7 +2482,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -2667,7 +2670,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2847,7 +2850,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -4140,7 +4144,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -4327,7 +4332,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -4507,7 +4512,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -5719,7 +5725,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -5906,7 +5913,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -6086,7 +6093,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -7059,7 +7067,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -7246,7 +7255,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -7426,7 +7435,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -8342,7 +8352,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -8529,7 +8540,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -8709,7 +8720,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -11317,7 +11329,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -11504,7 +11517,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -11684,7 +11697,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
diff --git a/docs/dyn/compute_v1.diskTypes.html b/docs/dyn/compute_v1.diskTypes.html
index e6c05a9e75..c3b20bbdf9 100644
--- a/docs/dyn/compute_v1.diskTypes.html
+++ b/docs/dyn/compute_v1.diskTypes.html
@@ -97,7 +97,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of disk types.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index 1dd559ec00..e73a7f326b 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -438,7 +438,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of persistent disks.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.firewalls.html b/docs/dyn/compute_v1.firewalls.html
index 757bbcaddb..6256bf7246 100644
--- a/docs/dyn/compute_v1.firewalls.html
+++ b/docs/dyn/compute_v1.firewalls.html
@@ -95,6 +95,9 @@ 
Instance Methods

 

   patch(project, firewall, body=None, requestId=None, x__xgafv=None)

 
Updates the specified firewall rule with the data included in the

+

+  testIamPermissions(project, resource, body=None, x__xgafv=None)

+
Returns permissions that a caller has on the specified resource.

 

   update(project, firewall, body=None, requestId=None, x__xgafv=None)

 
Updates the specified firewall rule with the data included in the

@@ -1780,6 +1783,39 @@ 
Method Details

 }

 

 
+

+    testIamPermissions(project, resource, body=None, x__xgafv=None)
+  
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}

+

+
 

     update(project, firewall, body=None, requestId=None, x__xgafv=None)
   
Updates the specified firewall rule with the data included in the
diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html
index 59666ff05d..0913eeac7c 100644
--- a/docs/dyn/compute_v1.forwardingRules.html
+++ b/docs/dyn/compute_v1.forwardingRules.html
@@ -112,7 +112,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of forwarding rules.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.futureReservations.html b/docs/dyn/compute_v1.futureReservations.html
index a5d1637ad2..b313dd9ac2 100644
--- a/docs/dyn/compute_v1.futureReservations.html
+++ b/docs/dyn/compute_v1.futureReservations.html
@@ -109,7 +109,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of future reservations.
 
-To prevent failure, recommendation is that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -305,6 +305,8 @@ 
Method Details

               # Maximum allowed length for name prefix is 20. Automatically created
               # reservations name format will be -date-####.
           "planningStatus": "A String", # Planning state before being submitted for evaluation
+          "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and
+              # expected pricing.
           "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of
               # delivery of  future reservations. If the reservation with the given name
               # does not exist already, it is created automatically at the time of Approval
@@ -1249,6 +1251,8 @@ 
Method Details

       # Maximum allowed length for name prefix is 20. Automatically created
       # reservations name format will be -date-####.
   "planningStatus": "A String", # Planning state before being submitted for evaluation
+  "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and
+      # expected pricing.
   "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of
       # delivery of  future reservations. If the reservation with the given name
       # does not exist already, it is created automatically at the time of Approval
@@ -1540,6 +1544,8 @@ 
Method Details

       # Maximum allowed length for name prefix is 20. Automatically created
       # reservations name format will be -date-####.
   "planningStatus": "A String", # Planning state before being submitted for evaluation
+  "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and
+      # expected pricing.
   "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of
       # delivery of  future reservations. If the reservation with the given name
       # does not exist already, it is created automatically at the time of Approval
@@ -2197,6 +2203,8 @@ 
Method Details

           # Maximum allowed length for name prefix is 20. Automatically created
           # reservations name format will be -date-####.
       "planningStatus": "A String", # Planning state before being submitted for evaluation
+      "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and
+          # expected pricing.
       "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of
           # delivery of  future reservations. If the reservation with the given name
           # does not exist already, it is created automatically at the time of Approval
@@ -2541,6 +2549,8 @@ 
Method Details

       # Maximum allowed length for name prefix is 20. Automatically created
       # reservations name format will be -date-####.
   "planningStatus": "A String", # Planning state before being submitted for evaluation
+  "reservationMode": "A String", # The reservation mode which determines reservation-termination behavior and
+      # expected pricing.
   "reservationName": "A String", # Name of reservations where the capacity is provisioned at the time of
       # delivery of  future reservations. If the reservation with the given name
       # does not exist already, it is created automatically at the time of Approval
diff --git a/docs/dyn/compute_v1.healthChecks.html b/docs/dyn/compute_v1.healthChecks.html
index d8e09c85fe..de11934bd7 100644
--- a/docs/dyn/compute_v1.healthChecks.html
+++ b/docs/dyn/compute_v1.healthChecks.html
@@ -289,6 +289,42 @@ 
Method Details

                 # port number determined by looking up the backend service's named port in
                 # the instance group's list of named ports.
           },
+          "grpcTlsHealthCheck": {
+            "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+                # value of grpc_service_name has the following meanings by convention:
+                #
+                # - Empty service_name means the overall status of all services at the
+                # backend.
+                #
+                # - Non-empty service_name means the health of that gRPC service, as defined
+                # by the owner of the service.
+                #
+                # The grpc_service_name can only be ASCII.
+            "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+                # values are 1 through 65535.
+            "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+                # following values:
+                # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+                # for passthrough load balancers and backend services for proxy load
+                # balancers. Not supported by target pools. The health check supports all
+                # backends supported by the backend service provided the backend can be
+                # health checked. For example, GCE_VM_IP network endpoint
+                # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+                # group backends.
+                #  USE_NAMED_PORT: Not supported.
+                # USE_SERVING_PORT: Provides an indirect method of specifying
+                # the health check port by referring to the backend service. Only supported
+                # by backend services for proxy load balancers. Not supported by target
+                # pools.  Not supported by backend services for passthrough load balancers.
+                # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+                # backends.
+                #
+                # For GCE_VM_IP_PORT network endpoint group backends, the health
+                # check uses the port number specified for each endpoint in the network
+                # endpoint group.  For instance group backends, the health check uses the
+                # port number determined by looking up the backend service's named port in
+                # the instance group's list of named ports.
+          },
           "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
               # many consecutive successes. The default value is 2.
           "http2HealthCheck": {
@@ -981,6 +1017,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
@@ -1304,6 +1376,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
@@ -1990,6 +2098,42 @@ 
Method Details

             # port number determined by looking up the backend service's named port in
             # the instance group's list of named ports.
       },
+      "grpcTlsHealthCheck": {
+        "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+            # value of grpc_service_name has the following meanings by convention:
+            #
+            # - Empty service_name means the overall status of all services at the
+            # backend.
+            #
+            # - Non-empty service_name means the health of that gRPC service, as defined
+            # by the owner of the service.
+            #
+            # The grpc_service_name can only be ASCII.
+        "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+            # values are 1 through 65535.
+        "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+            # following values:
+            # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+            # for passthrough load balancers and backend services for proxy load
+            # balancers. Not supported by target pools. The health check supports all
+            # backends supported by the backend service provided the backend can be
+            # health checked. For example, GCE_VM_IP network endpoint
+            # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+            # group backends.
+            #  USE_NAMED_PORT: Not supported.
+            # USE_SERVING_PORT: Provides an indirect method of specifying
+            # the health check port by referring to the backend service. Only supported
+            # by backend services for proxy load balancers. Not supported by target
+            # pools.  Not supported by backend services for passthrough load balancers.
+            # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+            # backends.
+            #
+            # For GCE_VM_IP_PORT network endpoint group backends, the health
+            # check uses the port number specified for each endpoint in the network
+            # endpoint group.  For instance group backends, the health check uses the
+            # port number determined by looking up the backend service's named port in
+            # the instance group's list of named ports.
+      },
       "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
           # many consecutive successes. The default value is 2.
       "http2HealthCheck": {
@@ -2364,6 +2508,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
@@ -2960,6 +3140,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html
index 2a1f4c0aae..dc01f07aa1 100644
--- a/docs/dyn/compute_v1.instanceTemplates.html
+++ b/docs/dyn/compute_v1.instanceTemplates.html
@@ -844,6 +844,8 @@ 
Method Details

                     # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+                "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+                    # or not. If enabled, also indicates the version of IGMP supported.
                 "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
                 "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
                     # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -2152,6 +2154,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -3463,6 +3467,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -4766,6 +4772,8 @@ 
Method Details

                 # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+            "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+                # or not. If enabled, also indicates the version of IGMP supported.
             "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
             "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
                 # one IPv6 access config, DIRECT_IPV6, is supported. If there
diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html
index 396a356a0b..92701049e9 100644
--- a/docs/dyn/compute_v1.instances.html
+++ b/docs/dyn/compute_v1.instances.html
@@ -646,6 +646,8 @@ 
Method Details

       # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+  "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+      # or not. If enabled, also indicates the version of IGMP supported.
   "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
   "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
       # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -2145,6 +2147,8 @@ 
Method Details

                   # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+              "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+                  # or not. If enabled, also indicates the version of IGMP supported.
               "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
               "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
                   # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -3958,6 +3962,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -6415,6 +6421,8 @@ 
Method Details

           # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+      "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+          # or not. If enabled, also indicates the version of IGMP supported.
       "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
       "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
           # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -7837,6 +7845,16 @@ 
Method Details

   An object of the form:
 
     { # A Shielded Instance Identity.
+  "eccP256EncryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the ECC P256 algorithm
+      # issued to the Shielded Instance's vTPM.
+    "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.
+    "ekPub": "A String", # A PEM-encoded public key.
+  },
+  "eccP256SigningKey": { # A Shielded Instance Identity Entry. # An Attestation Key (AK) made by the ECC P256 algorithm
+      # issued to the Shielded Instance's vTPM.
+    "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.
+    "ekPub": "A String", # A PEM-encoded public key.
+  },
   "encryptionKey": { # A Shielded Instance Identity Entry. # An Endorsement Key (EK) made by the RSA 2048 algorithm
       # issued to the Shielded Instance's vTPM.
     "ekCert": "A String", # A PEM-encoded X.509 certificate. This field can be empty.
@@ -8570,6 +8588,8 @@ 
Method Details

           # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+      "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+          # or not. If enabled, also indicates the version of IGMP supported.
       "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
       "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
           # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -10080,6 +10100,8 @@ 
Method Details

               # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+          "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+              # or not. If enabled, also indicates the version of IGMP supported.
           "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
           "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
               # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -19189,6 +19211,8 @@ 
Method Details

           # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+      "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+          # or not. If enabled, also indicates the version of IGMP supported.
       "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
       "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
           # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -20596,6 +20620,8 @@ 
Method Details

       # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+  "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+      # or not. If enabled, also indicates the version of IGMP supported.
   "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
   "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
       # one IPv6 access config, DIRECT_IPV6, is supported. If there
diff --git a/docs/dyn/compute_v1.interconnectAttachments.html b/docs/dyn/compute_v1.interconnectAttachments.html
index b84de22719..6eea219fa0 100644
--- a/docs/dyn/compute_v1.interconnectAttachments.html
+++ b/docs/dyn/compute_v1.interconnectAttachments.html
@@ -352,6 +352,72 @@ 
Method Details

             "A String",
           ],
           "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+          "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+              # type is L2_DEDICATED.
+              #
+              # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+              # within L2 packets are mapped to the destination appliances IP addresses.
+              # The packet is then encapsulated with the appliance IP address and sent to
+              # the edge appliance.
+            "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+                # rules. If VLANs are not explicitly mapped to any appliance, the
+                # defaultApplianceIpAddress is used.
+                #
+                # Each VLAN tag can be a single number or a range of numbers in the range
+                # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+                # VLAN tag ranges are enforced, and violating operations will be rejected.
+                #
+                # The VLAN tags in the Ethernet header must use an ethertype value of
+                # 0x88A8 or 0x8100.
+              "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+                "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+                    # address for ingress packets that match on a VLAN tag, but do not match
+                    # a more specific inner VLAN tag.
+                    #
+                    # Unset field (null-value) indicates both VLAN tags are required to be
+                    # mapped. Otherwise, defaultApplianceIpAddress is used.
+                "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+                    # contains two VLAN tags.
+                    #
+                    # A list of mapping rules from inner VLAN tags to IP addresses. If the
+                    # inner VLAN is not explicitly mapped to an IP address range, the
+                    # applianceIpAddress is used.
+                  { # The inner VLAN-to-Appliance mapping.
+                    "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                        # destination IP address for ingress packets that match on both VLAN
+                        # tags.
+                    "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                        # packet. Each entry can be a single number or a range of numbers in
+                        # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                        # and Non-overlapping VLAN tag ranges are enforced, and violating
+                        # operations will be rejected.
+                        #
+                        # The inner VLAN tags must have an ethertype value of 0x8100.
+                      "A String",
+                    ],
+                  },
+                ],
+                "name": "A String", # Optional. The name of this appliance mapping rule.
+              },
+            },
+            "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+                # IP when there is no VLAN mapping result found.
+                #
+                # Unset field (null-value) indicates the unmatched packet should be
+                # dropped.
+            "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+                # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+                # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+                # environments.
+              "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+                  # 16,777,215.
+            },
+            "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+            "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+                # source IP address for packets sent to the appliances, and must be used as
+                # the destination IP address for packets that should be sent out through
+                # this attachment.
+          },
           "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
               # which is essentially a hash of the labels set used for optimistic locking.
               # The fingerprint is initially generated by Compute Engine and changes after
@@ -388,6 +454,25 @@ 
Method Details

               # The opaque identifier of a PARTNER attachment used to initiate
               # provisioning with a selected partner.
               # Of the form "XXXXX/region/domain"
+          "params": { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+              # as part of resource payload.
+            "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+                # Tag keys and values have the same definition as resource
+                # manager tags. The field is allowed for INSERT
+                # only. The keys/values to set on the resource should be specified in
+                # either ID { : } or Namespaced format
+                # { : }.
+                # For example the following are valid inputs:
+                # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+                # * {"123/environment" : "production", "345/abc" : "xyz"}
+                # Note:
+                # * Invalid combinations of ID & namespaced format is not supported. For
+                #   instance: {"123/environment" : "tagValues/444"} is invalid.
+                # * Inconsistent format is not supported. For instance:
+                #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+              "a_key": "A String",
+            },
+          },
           "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
               # configured BGP on behalf of the customer.
               # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
@@ -483,6 +568,8 @@ 
Method Details

               #    customer.
               #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
               #    the partner.
+              #
+              # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
           "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
               # Only specified at creation time.
         },
@@ -1003,6 +1090,72 @@ 
Method Details

     "A String",
   ],
   "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+  "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+      # type is L2_DEDICATED.
+      #
+      # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+      # within L2 packets are mapped to the destination appliances IP addresses.
+      # The packet is then encapsulated with the appliance IP address and sent to
+      # the edge appliance.
+    "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+        # rules. If VLANs are not explicitly mapped to any appliance, the
+        # defaultApplianceIpAddress is used.
+        #
+        # Each VLAN tag can be a single number or a range of numbers in the range
+        # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+        # VLAN tag ranges are enforced, and violating operations will be rejected.
+        #
+        # The VLAN tags in the Ethernet header must use an ethertype value of
+        # 0x88A8 or 0x8100.
+      "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+        "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+            # address for ingress packets that match on a VLAN tag, but do not match
+            # a more specific inner VLAN tag.
+            #
+            # Unset field (null-value) indicates both VLAN tags are required to be
+            # mapped. Otherwise, defaultApplianceIpAddress is used.
+        "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+            # contains two VLAN tags.
+            #
+            # A list of mapping rules from inner VLAN tags to IP addresses. If the
+            # inner VLAN is not explicitly mapped to an IP address range, the
+            # applianceIpAddress is used.
+          { # The inner VLAN-to-Appliance mapping.
+            "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                # destination IP address for ingress packets that match on both VLAN
+                # tags.
+            "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                # packet. Each entry can be a single number or a range of numbers in
+                # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                # and Non-overlapping VLAN tag ranges are enforced, and violating
+                # operations will be rejected.
+                #
+                # The inner VLAN tags must have an ethertype value of 0x8100.
+              "A String",
+            ],
+          },
+        ],
+        "name": "A String", # Optional. The name of this appliance mapping rule.
+      },
+    },
+    "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+        # IP when there is no VLAN mapping result found.
+        #
+        # Unset field (null-value) indicates the unmatched packet should be
+        # dropped.
+    "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+        # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+        # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+        # environments.
+      "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+          # 16,777,215.
+    },
+    "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+    "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+        # source IP address for packets sent to the appliances, and must be used as
+        # the destination IP address for packets that should be sent out through
+        # this attachment.
+  },
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
       # which is essentially a hash of the labels set used for optimistic locking.
       # The fingerprint is initially generated by Compute Engine and changes after
@@ -1039,6 +1192,25 @@ 
Method Details

       # The opaque identifier of a PARTNER attachment used to initiate
       # provisioning with a selected partner.
       # Of the form "XXXXX/region/domain"
+  "params": { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # Tag keys and values have the same definition as resource
+        # manager tags. The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
   "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
       # configured BGP on behalf of the customer.
       # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
@@ -1134,6 +1306,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      #
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }

@@ -1283,6 +1457,72 @@ 
Method Details

     "A String",
   ],
   "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+  "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+      # type is L2_DEDICATED.
+      # 
+      # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+      # within L2 packets are mapped to the destination appliances IP addresses.
+      # The packet is then encapsulated with the appliance IP address and sent to
+      # the edge appliance.
+    "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+        # rules. If VLANs are not explicitly mapped to any appliance, the
+        # defaultApplianceIpAddress is used.
+        #
+        # Each VLAN tag can be a single number or a range of numbers in the range
+        # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+        # VLAN tag ranges are enforced, and violating operations will be rejected.
+        #
+        # The VLAN tags in the Ethernet header must use an ethertype value of
+        # 0x88A8 or 0x8100.
+      "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+        "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+            # address for ingress packets that match on a VLAN tag, but do not match
+            # a more specific inner VLAN tag.
+            #
+            # Unset field (null-value) indicates both VLAN tags are required to be
+            # mapped. Otherwise, defaultApplianceIpAddress is used.
+        "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+            # contains two VLAN tags.
+            #
+            # A list of mapping rules from inner VLAN tags to IP addresses. If the
+            # inner VLAN is not explicitly mapped to an IP address range, the
+            # applianceIpAddress is used.
+          { # The inner VLAN-to-Appliance mapping.
+            "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                # destination IP address for ingress packets that match on both VLAN
+                # tags.
+            "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                # packet. Each entry can be a single number or a range of numbers in
+                # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                # and Non-overlapping VLAN tag ranges are enforced, and violating
+                # operations will be rejected.
+                #
+                # The inner VLAN tags must have an ethertype value of 0x8100.
+              "A String",
+            ],
+          },
+        ],
+        "name": "A String", # Optional. The name of this appliance mapping rule.
+      },
+    },
+    "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+        # IP when there is no VLAN mapping result found.
+        #
+        # Unset field (null-value) indicates the unmatched packet should be
+        # dropped.
+    "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+        # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+        # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+        # environments.
+      "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+          # 16,777,215.
+    },
+    "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+    "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+        # source IP address for packets sent to the appliances, and must be used as
+        # the destination IP address for packets that should be sent out through
+        # this attachment.
+  },
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
       # which is essentially a hash of the labels set used for optimistic locking.
       # The fingerprint is initially generated by Compute Engine and changes after
@@ -1319,6 +1559,25 @@ 
Method Details

       # The opaque identifier of a PARTNER attachment used to initiate
       # provisioning with a selected partner.
       # Of the form "XXXXX/region/domain"
+  "params": { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # Tag keys and values have the same definition as resource
+        # manager tags. The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
   "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
       # configured BGP on behalf of the customer.
       # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
@@ -1414,6 +1673,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      # 
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }
@@ -1928,6 +2189,72 @@ 
Method Details

         "A String",
       ],
       "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+      "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+          # type is L2_DEDICATED.
+          #
+          # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+          # within L2 packets are mapped to the destination appliances IP addresses.
+          # The packet is then encapsulated with the appliance IP address and sent to
+          # the edge appliance.
+        "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+            # rules. If VLANs are not explicitly mapped to any appliance, the
+            # defaultApplianceIpAddress is used.
+            #
+            # Each VLAN tag can be a single number or a range of numbers in the range
+            # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+            # VLAN tag ranges are enforced, and violating operations will be rejected.
+            #
+            # The VLAN tags in the Ethernet header must use an ethertype value of
+            # 0x88A8 or 0x8100.
+          "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+            "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+                # address for ingress packets that match on a VLAN tag, but do not match
+                # a more specific inner VLAN tag.
+                #
+                # Unset field (null-value) indicates both VLAN tags are required to be
+                # mapped. Otherwise, defaultApplianceIpAddress is used.
+            "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+                # contains two VLAN tags.
+                #
+                # A list of mapping rules from inner VLAN tags to IP addresses. If the
+                # inner VLAN is not explicitly mapped to an IP address range, the
+                # applianceIpAddress is used.
+              { # The inner VLAN-to-Appliance mapping.
+                "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                    # destination IP address for ingress packets that match on both VLAN
+                    # tags.
+                "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                    # packet. Each entry can be a single number or a range of numbers in
+                    # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                    # and Non-overlapping VLAN tag ranges are enforced, and violating
+                    # operations will be rejected.
+                    #
+                    # The inner VLAN tags must have an ethertype value of 0x8100.
+                  "A String",
+                ],
+              },
+            ],
+            "name": "A String", # Optional. The name of this appliance mapping rule.
+          },
+        },
+        "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+            # IP when there is no VLAN mapping result found.
+            #
+            # Unset field (null-value) indicates the unmatched packet should be
+            # dropped.
+        "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+            # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+            # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+            # environments.
+          "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+              # 16,777,215.
+        },
+        "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+        "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+            # source IP address for packets sent to the appliances, and must be used as
+            # the destination IP address for packets that should be sent out through
+            # this attachment.
+      },
       "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
           # which is essentially a hash of the labels set used for optimistic locking.
           # The fingerprint is initially generated by Compute Engine and changes after
@@ -1964,6 +2291,25 @@ 
Method Details

           # The opaque identifier of a PARTNER attachment used to initiate
           # provisioning with a selected partner.
           # Of the form "XXXXX/region/domain"
+      "params": { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+          # as part of resource payload.
+        "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+            # Tag keys and values have the same definition as resource
+            # manager tags. The field is allowed for INSERT
+            # only. The keys/values to set on the resource should be specified in
+            # either ID { : } or Namespaced format
+            # { : }.
+            # For example the following are valid inputs:
+            # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+            # * {"123/environment" : "production", "345/abc" : "xyz"}
+            # Note:
+            # * Invalid combinations of ID & namespaced format is not supported. For
+            #   instance: {"123/environment" : "tagValues/444"} is invalid.
+            # * Inconsistent format is not supported. For instance:
+            #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+          "a_key": "A String",
+        },
+      },
       "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
           # configured BGP on behalf of the customer.
           # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
@@ -2059,6 +2405,8 @@ 
Method Details

           #    customer.
           #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
           #    the partner.
+          #
+          # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
       "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
           # Only specified at creation time.
     },
@@ -2260,6 +2608,72 @@ 
Method Details

     "A String",
   ],
   "kind": "compute#interconnectAttachment", # [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.
+  "l2Forwarding": { # L2 Interconnect Attachment related configuration. # L2 Interconnect Attachment related config. This field is required if the
+      # type is L2_DEDICATED.
+      # 
+      # The configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)
+      # within L2 packets are mapped to the destination appliances IP addresses.
+      # The packet is then encapsulated with the appliance IP address and sent to
+      # the edge appliance.
+    "applianceMappings": { # Optional. A map of VLAN tags to appliances and optional inner mapping
+        # rules. If VLANs are not explicitly mapped to any appliance, the
+        # defaultApplianceIpAddress is used.
+        #
+        # Each VLAN tag can be a single number or a range of numbers in the range
+        # of 1 to 4094, e.g., "1" or "4001-4094". Non-empty and non-overlapping
+        # VLAN tag ranges are enforced, and violating operations will be rejected.
+        #
+        # The VLAN tags in the Ethernet header must use an ethertype value of
+        # 0x88A8 or 0x8100.
+      "a_key": { # Two-level VLAN-to-Appliance mapping rule.
+        "applianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the destination IP
+            # address for ingress packets that match on a VLAN tag, but do not match
+            # a more specific inner VLAN tag.
+            #
+            # Unset field (null-value) indicates both VLAN tags are required to be
+            # mapped. Otherwise, defaultApplianceIpAddress is used.
+        "innerVlanToApplianceMappings": [ # Optional. Used to match against the inner VLAN when the packet
+            # contains two VLAN tags.
+            #
+            # A list of mapping rules from inner VLAN tags to IP addresses. If the
+            # inner VLAN is not explicitly mapped to an IP address range, the
+            # applianceIpAddress is used.
+          { # The inner VLAN-to-Appliance mapping.
+            "innerApplianceIpAddress": "A String", # Required in this object. A single IPv4 or IPv6 address used as the
+                # destination IP address for ingress packets that match on both VLAN
+                # tags.
+            "innerVlanTags": [ # Required in this object. Used to match the inner VLAN tag on the
+                # packet. Each entry can be a single number or a range of numbers in
+                # the range of 1 to 4094, e.g., ["1", "4001-4094"] is valid. Non-empty
+                # and Non-overlapping VLAN tag ranges are enforced, and violating
+                # operations will be rejected.
+                #
+                # The inner VLAN tags must have an ethertype value of 0x8100.
+              "A String",
+            ],
+          },
+        ],
+        "name": "A String", # Optional. The name of this appliance mapping rule.
+      },
+    },
+    "defaultApplianceIpAddress": "A String", # Optional. A single IPv4 or IPv6 address used as the default destination
+        # IP when there is no VLAN mapping result found.
+        #
+        # Unset field (null-value) indicates the unmatched packet should be
+        # dropped.
+    "geneveHeader": { # GeneveHeader related configurations. # Optional. It represents the structure of a Geneve (Generic Network
+        # Virtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various
+        # protocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization
+        # environments.
+      "vni": 42, # Optional. VNI is a 24-bit unique virtual network identifier, from 0 to
+          # 16,777,215.
+    },
+    "network": "A String", # Required. Resource URL of the network to which this attachment belongs.
+    "tunnelEndpointIpAddress": "A String", # Required. A single IPv4 or IPv6 address. This address will be used as the
+        # source IP address for packets sent to the appliances, and must be used as
+        # the destination IP address for packets that should be sent out through
+        # this attachment.
+  },
   "labelFingerprint": "A String", # A fingerprint for the labels being applied to this InterconnectAttachment,
       # which is essentially a hash of the labels set used for optimistic locking.
       # The fingerprint is initially generated by Compute Engine and changes after
@@ -2296,6 +2710,25 @@ 
Method Details

       # The opaque identifier of a PARTNER attachment used to initiate
       # provisioning with a selected partner.
       # Of the form "XXXXX/region/domain"
+  "params": { # Additional interconnect attachment parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # Tag keys and values have the same definition as resource
+        # manager tags. The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
   "partnerAsn": "A String", # Optional BGP ASN for the router supplied by a Layer 3 Partner if they
       # configured BGP on behalf of the customer.
       # Output only for PARTNER type, input only for PARTNER_PROVIDER, not
@@ -2391,6 +2824,8 @@ 
Method Details

       #    customer.
       #    - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by
       #    the partner.
+      # 
+      # - L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.
   "vlanTag8021q": 42, # The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.
       # Only specified at creation time.
 }
diff --git a/docs/dyn/compute_v1.interconnectGroups.html b/docs/dyn/compute_v1.interconnectGroups.html
index 0d58500c54..e0d562ac78 100644
--- a/docs/dyn/compute_v1.interconnectGroups.html
+++ b/docs/dyn/compute_v1.interconnectGroups.html
@@ -864,7 +864,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
@@ -1556,7 +1556,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
@@ -2039,7 +2039,7 @@ 
Method Details

           # If provided when patching a configuration in update mode, the provided
           # token must match the current token or the update is rejected. This provides
           # a reliable means of doing read-modify-write (optimistic locking) as
-          # described byAPI 154.
+          # described by AIP 154.
       "id": "A String", # [Output Only] The unique identifier for the resource type. The server
           # generates this identifier.
       "intent": { # The user's intent for this group. This is the only required field besides
@@ -2213,7 +2213,7 @@ 
Method Details

       # If provided when patching a configuration in update mode, the provided
       # token must match the current token or the update is rejected. This provides
       # a reliable means of doing read-modify-write (optimistic locking) as
-      # described byAPI 154.
+      # described by AIP 154.
   "id": "A String", # [Output Only] The unique identifier for the resource type. The server
       # generates this identifier.
   "intent": { # The user's intent for this group. This is the only required field besides
diff --git a/docs/dyn/compute_v1.interconnectLocations.html b/docs/dyn/compute_v1.interconnectLocations.html
index 4324151d8f..4356b676a7 100644
--- a/docs/dyn/compute_v1.interconnectLocations.html
+++ b/docs/dyn/compute_v1.interconnectLocations.html
@@ -175,6 +175,8 @@ 
Method Details

         # Region.
       "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation
           # to a VM in this region.
+      "l2ForwardingEnabled": True or False, # Identifies whether L2 Interconnect Attachments can be created in this
+          # region for interconnects that are in this location.
       "locationPresence": "A String", # Identifies the network presence of this location.
       "region": "A String", # URL for the region of this location.
     },
@@ -364,6 +366,8 @@ 
Method Details

             # Region.
           "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation
               # to a VM in this region.
+          "l2ForwardingEnabled": True or False, # Identifies whether L2 Interconnect Attachments can be created in this
+              # region for interconnects that are in this location.
           "locationPresence": "A String", # Identifies the network presence of this location.
           "region": "A String", # URL for the region of this location.
         },
diff --git a/docs/dyn/compute_v1.interconnects.html b/docs/dyn/compute_v1.interconnects.html
index 8ac8bbdb77..9b42a60504 100644
--- a/docs/dyn/compute_v1.interconnects.html
+++ b/docs/dyn/compute_v1.interconnects.html
@@ -626,6 +626,25 @@ 
Method Details

       # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
       # maintenance. No attachments may be provisioned or updated on this
       # Interconnect.
+  "params": { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # Tag keys and values have the same definition as resource
+        # manager tags. The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
   "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the
       # Interconnect link. The customer should configure this IP address during
       # turnup when prompted by Google NOC. This can be used only for ping tests.
@@ -1051,6 +1070,25 @@ 
Method Details

       # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
       # maintenance. No attachments may be provisioned or updated on this
       # Interconnect.
+  "params": { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # Tag keys and values have the same definition as resource
+        # manager tags. The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
   "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the
       # Interconnect link. The customer should configure this IP address during
       # turnup when prompted by Google NOC. This can be used only for ping tests.
@@ -1685,6 +1723,25 @@ 
Method Details

           # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
           # maintenance. No attachments may be provisioned or updated on this
           # Interconnect.
+      "params": { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+          # as part of resource payload.
+        "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+            # Tag keys and values have the same definition as resource
+            # manager tags. The field is allowed for INSERT
+            # only. The keys/values to set on the resource should be specified in
+            # either ID { : } or Namespaced format
+            # { : }.
+            # For example the following are valid inputs:
+            # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+            # * {"123/environment" : "production", "345/abc" : "xyz"}
+            # Note:
+            # * Invalid combinations of ID & namespaced format is not supported. For
+            #   instance: {"123/environment" : "tagValues/444"} is invalid.
+            # * Inconsistent format is not supported. For instance:
+            #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+          "a_key": "A String",
+        },
+      },
       "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the
           # Interconnect link. The customer should configure this IP address during
           # turnup when prompted by Google NOC. This can be used only for ping tests.
@@ -2008,6 +2065,25 @@ 
Method Details

       # - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
       # maintenance. No attachments may be provisioned or updated on this
       # Interconnect.
+  "params": { # Additional interconnect parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # Tag keys and values have the same definition as resource
+        # manager tags. The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
   "peerIpAddress": "A String", # [Output Only] IP address configured on the customer side of the
       # Interconnect link. The customer should configure this IP address during
       # turnup when prompted by Google NOC. This can be used only for ping tests.
diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html
index cbb26ed7c7..f01ad08c74 100644
--- a/docs/dyn/compute_v1.machineImages.html
+++ b/docs/dyn/compute_v1.machineImages.html
@@ -1009,6 +1009,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -1694,6 +1696,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -2909,6 +2913,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -3594,6 +3600,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -4802,6 +4810,8 @@ 
Method Details

                 # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+            "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+                # or not. If enabled, also indicates the version of IGMP supported.
             "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
             "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
                 # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -5487,6 +5497,8 @@ 
Method Details

                 # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+            "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+                # or not. If enabled, also indicates the version of IGMP supported.
             "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
             "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
                 # one IPv6 access config, DIRECT_IPV6, is supported. If there
diff --git a/docs/dyn/compute_v1.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html
index dfabe2599a..149dba4b40 100644
--- a/docs/dyn/compute_v1.networkFirewallPolicies.html
+++ b/docs/dyn/compute_v1.networkFirewallPolicies.html
@@ -1332,7 +1332,7 @@ 
Method Details

 firewall policies from all applicable scopes (global and regional) and
 grouping the results per scope.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
diff --git a/docs/dyn/compute_v1.networkProfiles.html b/docs/dyn/compute_v1.networkProfiles.html
index 4a5affab5a..fccff5aebf 100644
--- a/docs/dyn/compute_v1.networkProfiles.html
+++ b/docs/dyn/compute_v1.networkProfiles.html
@@ -129,6 +129,7 @@ 
Method Details

     "allowIpForwarding": "A String", # Specifies whether IP forwarding is allowed.
     "allowLoadBalancing": "A String", # Specifies whether cloud load balancing is allowed.
     "allowMultiNicInSameNetwork": "A String", # Specifies whether multi-nic in the same network is allowed.
+    "allowMulticast": "A String", # Specifies whether multicast is allowed.
     "allowNcc": "A String", # Specifies whether NCC is allowed.
     "allowNetworkMigration": "A String", # Specifies whether VM network migration is allowed.
     "allowPacketMirroring": "A String", # Specifies whether Packet Mirroring 1.0 is supported.
@@ -143,6 +144,7 @@ 
Method Details

         # empty, all interface types are supported.
       "A String",
     ],
+    "multicast": "A String", # Specifies which type of multicast is supported.
     "subnetPurposes": [ # Specifies which subnetwork purposes are supported.
       "A String",
     ],
@@ -300,6 +302,7 @@ 
Method Details

         "allowIpForwarding": "A String", # Specifies whether IP forwarding is allowed.
         "allowLoadBalancing": "A String", # Specifies whether cloud load balancing is allowed.
         "allowMultiNicInSameNetwork": "A String", # Specifies whether multi-nic in the same network is allowed.
+        "allowMulticast": "A String", # Specifies whether multicast is allowed.
         "allowNcc": "A String", # Specifies whether NCC is allowed.
         "allowNetworkMigration": "A String", # Specifies whether VM network migration is allowed.
         "allowPacketMirroring": "A String", # Specifies whether Packet Mirroring 1.0 is supported.
@@ -314,6 +317,7 @@ 
Method Details

             # empty, all interface types are supported.
           "A String",
         ],
+        "multicast": "A String", # Specifies which type of multicast is supported.
         "subnetPurposes": [ # Specifies which subnetwork purposes are supported.
           "A String",
         ],
diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html
index eab4472c57..a43bdd6ca1 100644
--- a/docs/dyn/compute_v1.projects.html
+++ b/docs/dyn/compute_v1.projects.html
@@ -109,7 +109,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   moveDisk(project, body=None, requestId=None, x__xgafv=None)

-
Starting September 29, 2025, you can't use the moveDisk API on new

+
Moves a persistent disk from one zone to another.

 

   moveInstance(project, body=None, requestId=None, x__xgafv=None)

 
Moves an instance and its attached persistent disks from one zone to

@@ -1858,10 +1858,13 @@ 
Method Details

 
 

     moveDisk(project, body=None, requestId=None, x__xgafv=None)
-  
Starting September 29, 2025, you can't use the moveDisk API on new
+  
Moves a persistent disk from one zone to another.
+*Note*: The moveDisk API will be deprecated on September 29, 2026.
+
+Starting September 29, 2025, you can't use the moveDisk API on new
 projects. To move a disk to a different region or zone, follow the steps in
 [Change the location of a
-disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
+disk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).
 
 Projects that already use the moveDisk API can continue usage until
 September 29, 2026.
diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html
index b6a609476f..2e3f06d8e4 100644
--- a/docs/dyn/compute_v1.regionBackendServices.html
+++ b/docs/dyn/compute_v1.regionBackendServices.html
@@ -485,7 +485,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -672,7 +673,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -852,7 +853,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -2128,7 +2130,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -2315,7 +2318,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -2495,7 +2498,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -3708,7 +3712,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -3895,7 +3900,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -4075,7 +4080,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -5051,7 +5057,8 @@ 
Method Details

               "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
                   # balancing mode. The valid range is [0.0, 1.0].
               "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-                  # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+                  # long and match the regular expression
+                  # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
                   # first character must be a lowercase letter, and all following
                   # characters must be a dash, period, underscore, lowercase letter, or
                   # digit, except the last character, which cannot be a dash, period, or
@@ -5238,7 +5245,7 @@ 
Method Details

             # negative caching when a policy exists.
           { # Specify CDN TTLs for response error codes.
             "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+                # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
                 # specified as values, and you cannot specify a status code more than
                 # once.
             "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -5418,7 +5425,8 @@ 
Method Details

             # locality_lb_policy.
           "dryRun": True or False, # If true, the metric data is not used for load balancing.
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -6335,7 +6343,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -6522,7 +6531,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -6702,7 +6711,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
@@ -9027,7 +9037,8 @@ 
Method Details

           "maxUtilization": 3.14, # Optional parameter to define a target utilization for the Custom Metrics
               # balancing mode. The valid range is [0.0, 1.0].
           "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-              # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+              # long and match the regular expression
+              # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
               # first character must be a lowercase letter, and all following
               # characters must be a dash, period, underscore, lowercase letter, or
               # digit, except the last character, which cannot be a dash, period, or
@@ -9214,7 +9225,7 @@ 
Method Details

         # negative caching when a policy exists.
       { # Specify CDN TTLs for response error codes.
         "code": 42, # The HTTP status code to define a TTL against. Only HTTP status codes
-            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be
+            # 300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be
             # specified as values, and you cannot specify a status code more than
             # once.
         "ttl": 42, # The TTL (in seconds) for which to cache responses with the
@@ -9394,7 +9405,8 @@ 
Method Details

         # locality_lb_policy.
       "dryRun": True or False, # If true, the metric data is not used for load balancing.
       "name": "A String", # Name of a custom utilization signal. The name must be 1-64 characters
-          # long and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the
+          # long and match the regular expression
+          # `[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the
           # first character must be a lowercase letter, and all following
           # characters must be a dash, period, underscore, lowercase letter, or
           # digit, except the last character, which cannot be a dash, period, or
diff --git a/docs/dyn/compute_v1.regionCommitments.html b/docs/dyn/compute_v1.regionCommitments.html
index 07c8033e2e..628d5ba3ea 100644
--- a/docs/dyn/compute_v1.regionCommitments.html
+++ b/docs/dyn/compute_v1.regionCommitments.html
@@ -103,7 +103,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of commitments by region.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -357,6 +357,9 @@ 
Method Details

                   # character must be a lowercase letter, and all following characters must be
                   # a dash, lowercase letter, or digit, except the last character, which cannot
                   # be a dash.
+              "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+                  # in the event of infrastructure failures at data center (e.g. power
+                  # and/or cooling failures).
               "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
                   # will not be shared with Google Cloud managed services.
                 "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -798,6 +801,9 @@ 
Method Details

           # character must be a lowercase letter, and all following characters must be
           # a dash, lowercase letter, or digit, except the last character, which cannot
           # be a dash.
+      "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+          # in the event of infrastructure failures at data center (e.g. power
+          # and/or cooling failures).
       "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
           # will not be shared with Google Cloud managed services.
         "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -1149,6 +1155,9 @@ 
Method Details

           # character must be a lowercase letter, and all following characters must be
           # a dash, lowercase letter, or digit, except the last character, which cannot
           # be a dash.
+      "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+          # in the event of infrastructure failures at data center (e.g. power
+          # and/or cooling failures).
       "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
           # will not be shared with Google Cloud managed services.
         "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -1863,6 +1872,9 @@ 
Method Details

               # character must be a lowercase letter, and all following characters must be
               # a dash, lowercase letter, or digit, except the last character, which cannot
               # be a dash.
+          "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+              # in the event of infrastructure failures at data center (e.g. power
+              # and/or cooling failures).
           "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
               # will not be shared with Google Cloud managed services.
             "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -2265,6 +2277,9 @@ 
Method Details

           # character must be a lowercase letter, and all following characters must be
           # a dash, lowercase letter, or digit, except the last character, which cannot
           # be a dash.
+      "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+          # in the event of infrastructure failures at data center (e.g. power
+          # and/or cooling failures).
       "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
           # will not be shared with Google Cloud managed services.
         "serviceShareType": "A String", # Sharing config for all Google Cloud services.
diff --git a/docs/dyn/compute_v1.regionHealthChecks.html b/docs/dyn/compute_v1.regionHealthChecks.html
index 9194eb617c..6dc9dd64f7 100644
--- a/docs/dyn/compute_v1.regionHealthChecks.html
+++ b/docs/dyn/compute_v1.regionHealthChecks.html
@@ -470,6 +470,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
@@ -794,6 +830,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
@@ -1481,6 +1553,42 @@ 
Method Details

             # port number determined by looking up the backend service's named port in
             # the instance group's list of named ports.
       },
+      "grpcTlsHealthCheck": {
+        "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+            # value of grpc_service_name has the following meanings by convention:
+            #
+            # - Empty service_name means the overall status of all services at the
+            # backend.
+            #
+            # - Non-empty service_name means the health of that gRPC service, as defined
+            # by the owner of the service.
+            #
+            # The grpc_service_name can only be ASCII.
+        "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+            # values are 1 through 65535.
+        "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+            # following values:
+            # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+            # for passthrough load balancers and backend services for proxy load
+            # balancers. Not supported by target pools. The health check supports all
+            # backends supported by the backend service provided the backend can be
+            # health checked. For example, GCE_VM_IP network endpoint
+            # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+            # group backends.
+            #  USE_NAMED_PORT: Not supported.
+            # USE_SERVING_PORT: Provides an indirect method of specifying
+            # the health check port by referring to the backend service. Only supported
+            # by backend services for proxy load balancers. Not supported by target
+            # pools.  Not supported by backend services for passthrough load balancers.
+            # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+            # backends.
+            #
+            # For GCE_VM_IP_PORT network endpoint group backends, the health
+            # check uses the port number specified for each endpoint in the network
+            # endpoint group.  For instance group backends, the health check uses the
+            # port number determined by looking up the backend service's named port in
+            # the instance group's list of named ports.
+      },
       "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
           # many consecutive successes. The default value is 2.
       "http2HealthCheck": {
@@ -1856,6 +1964,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
@@ -2453,6 +2597,42 @@ 
Method Details

         # port number determined by looking up the backend service's named port in
         # the instance group's list of named ports.
   },
+  "grpcTlsHealthCheck": {
+    "grpcServiceName": "A String", # The gRPC service name for the health check. This field is optional. The
+        # value of grpc_service_name has the following meanings by convention:
+        #
+        # - Empty service_name means the overall status of all services at the
+        # backend.
+        #
+        # - Non-empty service_name means the health of that gRPC service, as defined
+        # by the owner of the service.
+        #
+        # The grpc_service_name can only be ASCII.
+    "port": 42, # The TCP port number to which the health check prober sends packets. Valid
+        # values are 1 through 65535.
+    "portSpecification": "A String", # Specifies how a port is selected for health checking. Can be one of the
+        # following values:
+        # USE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services
+        # for passthrough load balancers and backend services for proxy load
+        # balancers. Not supported by target pools. The health check supports all
+        # backends supported by the backend service provided the backend can be
+        # health checked. For example, GCE_VM_IP network endpoint
+        # groups, GCE_VM_IP_PORT network endpoint groups, and instance
+        # group backends.
+        #  USE_NAMED_PORT: Not supported.
+        # USE_SERVING_PORT: Provides an indirect method of specifying
+        # the health check port by referring to the backend service. Only supported
+        # by backend services for proxy load balancers. Not supported by target
+        # pools.  Not supported by backend services for passthrough load balancers.
+        # Supports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group
+        # backends.
+        #
+        # For GCE_VM_IP_PORT network endpoint group backends, the health
+        # check uses the port number specified for each endpoint in the network
+        # endpoint group.  For instance group backends, the health check uses the
+        # port number determined by looking up the backend service's named port in
+        # the instance group's list of named ports.
+  },
   "healthyThreshold": 42, # A so-far unhealthy instance will be marked healthy after this
       # many consecutive successes. The default value is 2.
   "http2HealthCheck": {
diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html
index 4d7b0b44ad..d313929e90 100644
--- a/docs/dyn/compute_v1.regionInstanceTemplates.html
+++ b/docs/dyn/compute_v1.regionInstanceTemplates.html
@@ -1016,6 +1016,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -1957,6 +1959,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
@@ -3261,6 +3265,8 @@ 
Method Details

                 # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+            "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+                # or not. If enabled, also indicates the version of IGMP supported.
             "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
             "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
                 # one IPv6 access config, DIRECT_IPV6, is supported. If there
diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html
index caac7ab382..fb831fb39a 100644
--- a/docs/dyn/compute_v1.regionInstances.html
+++ b/docs/dyn/compute_v1.regionInstances.html
@@ -687,6 +687,8 @@ 
Method Details

             # 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 theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.
+        "igmpQuery": "A String", # Indicate whether igmp query is enabled on the network interface
+            # or not. If enabled, also indicates the version of IGMP supported.
         "internalIpv6PrefixLength": 42, # The prefix length of the primary internal IPv6 range.
         "ipv6AccessConfigs": [ # An array of IPv6 access configurations for this interface. Currently, only
             # one IPv6 access config, DIRECT_IPV6, is supported. If there
diff --git a/docs/dyn/compute_v1.reservationSubBlocks.html b/docs/dyn/compute_v1.reservationSubBlocks.html
index 24d744ca4c..7b74744970 100644
--- a/docs/dyn/compute_v1.reservationSubBlocks.html
+++ b/docs/dyn/compute_v1.reservationSubBlocks.html
@@ -78,7 +78,7 @@ 
Instance Methods

   close()

 
Close httplib2 connections.

 

-  get(project, zone, parentName, reservationSubBlock, x__xgafv=None)

+  get(project, zone, parentName, reservationSubBlock, view=None, x__xgafv=None)

 
Retrieves information about the specified reservation subBlock.

 

   getIamPolicy(project, zone, parentResource, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

@@ -108,7 +108,7 @@ 
Method Details

 

 
 

-    get(project, zone, parentName, reservationSubBlock, x__xgafv=None)
+    get(project, zone, parentName, reservationSubBlock, view=None, x__xgafv=None)
   
Retrieves information about the specified reservation subBlock.
 
 Args:
@@ -118,6 +118,11 @@ 
Method Details

 reservations/{reservation_name}/reservationBlocks/{reservation_block_name} (required)
   reservationSubBlock: string, The name of the reservation subBlock.
 Name should conform to RFC1035 or be a resource ID. (required)
+  view: string, View of the subBlock.
+    Allowed values
+      SUB_BLOCK_VIEW_BASIC - This view includes basic information about the reservation sub block
+      SUB_BLOCK_VIEW_FULL - Includes detailed topology view.
+      SUB_BLOCK_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -128,6 +133,19 @@ 
Method Details

 
     {
   "resource": { # Represents a reservation subBlock resource.
+    "acceleratorTopologiesInfo": { # Info for accelerator topologies within a densely packed reservation. # [Output Only] Slice info for the reservation subBlock.
+      "acceleratorTopologyInfos": [ # Info for each accelerator topology.
+        { # Info for a slice of a given topology.
+          "acceleratorTopology": "A String", # The accelerator topology.
+          "infoPerTopologyStates": [ # Info for each topology state.
+            { # Info for each topology state.
+              "count": 42, # The number of accelerator topologies in this state.
+              "state": "A String", # The state of the accelerator topology.
+            },
+          ],
+        },
+      ],
+    },
     "count": 42, # [Output Only] The number of hosts that are allocated in this
         # reservation subBlock.
     "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format.
@@ -667,6 +685,19 @@ 
Method Details

   "id": "A String", # Unique identifier for the resource; defined by the server.
   "items": [ # A list of reservation subBlock resources.
     { # Represents a reservation subBlock resource.
+      "acceleratorTopologiesInfo": { # Info for accelerator topologies within a densely packed reservation. # [Output Only] Slice info for the reservation subBlock.
+        "acceleratorTopologyInfos": [ # Info for each accelerator topology.
+          { # Info for a slice of a given topology.
+            "acceleratorTopology": "A String", # The accelerator topology.
+            "infoPerTopologyStates": [ # Info for each topology state.
+              { # Info for each topology state.
+                "count": 42, # The number of accelerator topologies in this state.
+                "state": "A String", # The state of the accelerator topology.
+              },
+            ],
+          },
+        ],
+      },
       "count": 42, # [Output Only] The number of hosts that are allocated in this
           # reservation subBlock.
       "creationTimestamp": "A String", # [Output Only] Creation timestamp inRFC3339 text format.
diff --git a/docs/dyn/compute_v1.reservations.html b/docs/dyn/compute_v1.reservations.html
index 192716a987..5ba5761f31 100644
--- a/docs/dyn/compute_v1.reservations.html
+++ b/docs/dyn/compute_v1.reservations.html
@@ -121,7 +121,7 @@ 
Method Details

     aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
   
Retrieves an aggregated list of reservations.
 
-To prevent failure, Google recommends that you set the
+To prevent failure, it is recommended that you set the
 `returnPartialSuccess` parameter to `true`.
 
 Args:
@@ -304,6 +304,9 @@ 
Method Details

               # character must be a lowercase letter, and all following characters must be
               # a dash, lowercase letter, or digit, except the last character, which cannot
               # be a dash.
+          "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+              # in the event of infrastructure failures at data center (e.g. power
+              # and/or cooling failures).
           "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
               # will not be shared with Google Cloud managed services.
             "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -894,6 +897,9 @@ 
Method Details

       # character must be a lowercase letter, and all following characters must be
       # a dash, lowercase letter, or digit, except the last character, which cannot
       # be a dash.
+  "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+      # in the event of infrastructure failures at data center (e.g. power
+      # and/or cooling failures).
   "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
       # will not be shared with Google Cloud managed services.
     "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -1483,6 +1489,9 @@ 
Method Details

       # character must be a lowercase letter, and all following characters must be
       # a dash, lowercase letter, or digit, except the last character, which cannot
       # be a dash.
+  "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+      # in the event of infrastructure failures at data center (e.g. power
+      # and/or cooling failures).
   "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
       # will not be shared with Google Cloud managed services.
     "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -2067,6 +2076,9 @@ 
Method Details

           # character must be a lowercase letter, and all following characters must be
           # a dash, lowercase letter, or digit, except the last character, which cannot
           # be a dash.
+      "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+          # in the event of infrastructure failures at data center (e.g. power
+          # and/or cooling failures).
       "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
           # will not be shared with Google Cloud managed services.
         "serviceShareType": "A String", # Sharing config for all Google Cloud services.
@@ -3825,6 +3837,9 @@ 
Method Details

       # character must be a lowercase letter, and all following characters must be
       # a dash, lowercase letter, or digit, except the last character, which cannot
       # be a dash.
+  "protectionTier": "A String", # Protection tier for the workload which specifies the workload expectations
+      # in the event of infrastructure failures at data center (e.g. power
+      # and/or cooling failures).
   "reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation
       # will not be shared with Google Cloud managed services.
     "serviceShareType": "A String", # Sharing config for all Google Cloud services.
diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html
index 4c0cd4d490..1c414a383e 100644
--- a/docs/dyn/compute_v1.routers.html
+++ b/docs/dyn/compute_v1.routers.html
@@ -2467,7 +2467,9 @@ 
Method Details

             # cases where multiple routes have equal prefix length, the one with the
             # lowest-numbered priority value wins. The default value is `1000`. The
             # priority value must be from `0` to `65535`, inclusive.
-        "routeStatus": "A String", # [Output only] The status of the route.
+        "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+            # dynamic routes learned by Cloud Routers. This status is not applicable
+            # to static routes.
         "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
             # values:
             # - 'TRANSIT' for a transit route that this router learned from
@@ -2630,7 +2632,9 @@ 
Method Details

             # cases where multiple routes have equal prefix length, the one with the
             # lowest-numbered priority value wins. The default value is `1000`. The
             # priority value must be from `0` to `65535`, inclusive.
-        "routeStatus": "A String", # [Output only] The status of the route.
+        "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+            # dynamic routes learned by Cloud Routers. This status is not applicable
+            # to static routes.
         "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
             # values:
             # - 'TRANSIT' for a transit route that this router learned from
@@ -2791,7 +2795,9 @@ 
Method Details

                 # cases where multiple routes have equal prefix length, the one with the
                 # lowest-numbered priority value wins. The default value is `1000`. The
                 # priority value must be from `0` to `65535`, inclusive.
-            "routeStatus": "A String", # [Output only] The status of the route.
+            "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+                # dynamic routes learned by Cloud Routers. This status is not applicable
+                # to static routes.
             "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
                 # values:
                 # - 'TRANSIT' for a transit route that this router learned from
diff --git a/docs/dyn/compute_v1.routes.html b/docs/dyn/compute_v1.routes.html
index dfdc5810d2..36c38dc08c 100644
--- a/docs/dyn/compute_v1.routes.html
+++ b/docs/dyn/compute_v1.routes.html
@@ -509,7 +509,9 @@ 
Method Details

       # cases where multiple routes have equal prefix length, the one with the
       # lowest-numbered priority value wins. The default value is `1000`. The
       # priority value must be from `0` to `65535`, inclusive.
-  "routeStatus": "A String", # [Output only] The status of the route.
+  "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+      # dynamic routes learned by Cloud Routers. This status is not applicable
+      # to static routes.
   "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
       # values:
       # - 'TRANSIT' for a transit route that this router learned from
@@ -678,7 +680,9 @@ 
Method Details

       # cases where multiple routes have equal prefix length, the one with the
       # lowest-numbered priority value wins. The default value is `1000`. The
       # priority value must be from `0` to `65535`, inclusive.
-  "routeStatus": "A String", # [Output only] The status of the route.
+  "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+      # dynamic routes learned by Cloud Routers. This status is not applicable
+      # to static routes.
   "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
       # values:
       # - 'TRANSIT' for a transit route that this router learned from
@@ -1209,7 +1213,9 @@ 
Method Details

           # cases where multiple routes have equal prefix length, the one with the
           # lowest-numbered priority value wins. The default value is `1000`. The
           # priority value must be from `0` to `65535`, inclusive.
-      "routeStatus": "A String", # [Output only] The status of the route.
+      "routeStatus": "A String", # [Output only] The status of the route. This status only applies to
+          # dynamic routes learned by Cloud Routers. This status is not applicable
+          # to static routes.
       "routeType": "A String", # [Output Only] The type of this route, which can be one of the following
           # values:
           # - 'TRANSIT' for a transit route that this router learned from
diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html
index c352ec8980..fb6d7621a4 100644
--- a/docs/dyn/compute_v1.subnetworks.html
+++ b/docs/dyn/compute_v1.subnetworks.html
@@ -75,7 +75,7 @@
 
Compute Engine API . subnetworks

 
Instance Methods

 

-  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)

+  aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)

 
Retrieves an aggregated list of subnetworks.

 

   aggregatedList_next()

@@ -124,7 +124,7 @@ 
Instance Methods

 
Returns permissions that a caller has on the specified resource.

 
Method Details

 

-    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
+    aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, views=None, x__xgafv=None)
   
Retrieves an aggregated list of subnetworks.
 
 To prevent failure, Google recommends that you set the
@@ -224,6 +224,14 @@ 
Method Details

 with an error code.
   serviceProjectNumber: string, The Shared VPC service project id or service project number for which
 aggregated list request is invoked for subnetworks list-usable api.
+  views: string, Defines the extra views returned back in the subnetwork resource.
+Supported values:
+   
+   - WITH_UTILIZATION: Utilization data is included in the
+   response. (repeated)
+    Allowed values
+      DEFAULT - 
+      WITH_UTILIZATION - Utilization data is included in the response.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json
index 9543013d60..a47a5f38bb 100644
--- a/googleapiclient/discovery_cache/documents/compute.alpha.json
+++ b/googleapiclient/discovery_cache/documents/compute.alpha.json
@@ -126,7 +126,7 @@
 "acceleratorTypes": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/acceleratorTypes",
 "httpMethod": "GET",
 "id": "compute.acceleratorTypes.aggregatedList",
@@ -302,7 +302,7 @@
 "addresses": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/addresses",
 "httpMethod": "GET",
 "id": "compute.addresses.aggregatedList",
@@ -791,7 +791,7 @@
 "autoscalers": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/autoscalers",
 "httpMethod": "GET",
 "id": "compute.autoscalers.aggregatedList",
@@ -1854,7 +1854,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/backendServices",
 "httpMethod": "GET",
 "id": "compute.backendServices.aggregatedList",
@@ -2853,7 +2853,7 @@
 "diskTypes": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/diskTypes",
 "httpMethod": "GET",
 "id": "compute.diskTypes.aggregatedList",
@@ -3079,7 +3079,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/disks",
 "httpMethod": "GET",
 "id": "compute.disks.aggregatedList",
@@ -5439,7 +5439,7 @@
 "forwardingRules": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/forwardingRules",
 "httpMethod": "GET",
 "id": "compute.forwardingRules.aggregatedList",
@@ -5900,7 +5900,7 @@
 "futureReservations": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, recommendation is that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/futureReservations",
 "httpMethod": "GET",
 "id": "compute.futureReservations.aggregatedList",
@@ -7924,8 +7924,8 @@
 },
 "delete": {
 "description": "Purge scoped resources (zonal policies) from a global VM extension\npolicy, and then delete the global VM extension policy. Purge of the scoped\nresources is a pre-condition of the global VM extension policy deletion.\nThe deletion of the global VM extension policy happens after the purge\nrollout is done, so it's not a part of the LRO. It's an automatic process\nthat triggers in the backend.",
-"flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
-"httpMethod": "PATCH",
+"flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete",
+"httpMethod": "POST",
 "id": "compute.globalVmExtensionPolicies.delete",
 "parameterOrder": [
 "project",
@@ -7949,39 +7949,12 @@
 "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
 "location": "query",
 "type": "string"
-},
-"rolloutInput.conflictBehavior": {
-"description": "Optional. [Optional] Specifies the behavior of the Rollout if a conflict is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) empty : don't overwrite the local value if conflict happens. This is\nthe default behavior.\n2) \"overwrite\" : Overwrite the local value with the rollout value.\nThe concept of \"conflict\" applies to:\n1) Insert action. If the zonal policy already exists when Insert\nhappens, it's a conflict.\n2) Update action. If the zonal policy was updated out of band by a\nzonal API, it's a conflict.",
-"location": "query",
-"type": "string"
-},
-"rolloutInput.name": {
-"description": "Optional. The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.",
-"location": "query",
-"type": "string"
-},
-"rolloutInput.predefinedRolloutPlan": {
-"description": "Optional. Predefined rollout plan.",
-"enum": [
-"FAST_ROLLOUT",
-"ROLLOUT_PLAN_UNSPECIFIED",
-"SLOW_ROLLOUT"
-],
-"enumDescriptions": [
-"",
-"",
-""
-],
-"location": "query",
-"type": "string"
-},
-"rolloutInput.retryUuid": {
-"description": "Optional. The UUID of the retry action. Only set it if this is a retry\nfor an existing resource. This is for the user re-populate the resource\nwithout changes. An error will be returned if the retry_uuid is set but\nthe resource get modified.",
-"location": "query",
-"type": "string"
 }
 },
-"path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
+"path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete",
+"request": {
+"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput"
+},
 "response": {
 "$ref": "Operation"
 },
@@ -8159,6 +8132,72 @@
 },
 "haControllers": {
 "methods": {
+"aggregatedList": {
+"description": "Retrieves an aggregated list of all of the HaControllers in the specified\nproject across all regions.",
+"flatPath": "projects/{project}/aggregated/haControllers",
+"httpMethod": "GET",
+"id": "compute.haControllers.aggregatedList",
+"parameterOrder": [
+"project"
+],
+"parameters": {
+"filter": {
+"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+"location": "query",
+"type": "string"
+},
+"includeAllScopes": {
+"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
+"location": "query",
+"type": "boolean"
+},
+"maxResults": {
+"default": "500",
+"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+"format": "uint32",
+"location": "query",
+"minimum": "0",
+"type": "integer"
+},
+"orderBy": {
+"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+"location": "query",
+"type": "string"
+},
+"pageToken": {
+"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+"location": "query",
+"type": "boolean"
+},
+"serviceProjectNumber": {
+"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
+"format": "int64",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/aggregated/haControllers",
+"response": {
+"$ref": "HaControllersAggregatedList"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
 "delete": {
 "description": "Deletes an HaController in the specified project.",
 "flatPath": "projects/{project}/regions/{region}/haControllers/{haController}",
@@ -20634,7 +20673,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/firewallPolicies",
 "httpMethod": "GET",
 "id": "compute.networkFirewallPolicies.aggregatedList",
@@ -25071,7 +25110,7 @@
 },
 "moveDisk": {
 "deprecated": true,
-"description": "Starting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
+"description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
 "flatPath": "projects/{project}/moveDisk",
 "httpMethod": "POST",
 "id": "compute.projects.moveDisk",
@@ -27793,7 +27832,7 @@
 "regionCommitments": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/commitments",
 "httpMethod": "GET",
 "id": "compute.regionCommitments.aggregatedList",
@@ -28262,7 +28301,7 @@
 "regionCompositeHealthChecks": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/compositeHealthChecks",
 "httpMethod": "GET",
 "id": "compute.regionCompositeHealthChecks.aggregatedList",
@@ -29797,7 +29836,7 @@
 "regionHealthAggregationPolicies": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/healthAggregationPolicies",
 "httpMethod": "GET",
 "id": "compute.regionHealthAggregationPolicies.aggregatedList",
@@ -30157,7 +30196,7 @@
 "regionHealthCheckServices": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/healthCheckServices",
 "httpMethod": "GET",
 "id": "compute.regionHealthCheckServices.aggregatedList",
@@ -40603,7 +40642,7 @@
 "reservations": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/reservations",
 "httpMethod": "GET",
 "id": "compute.reservations.aggregatedList",
@@ -41630,13 +41669,121 @@
 }
 }
 },
-"routers": {
+"rolloutPlans": {
 "methods": {
-"aggregatedList": {
-"description": "Retrieves an aggregated list of routers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
-"flatPath": "projects/{project}/aggregated/routers",
+"delete": {
+"description": "Deletes a RolloutPlan.",
+"flatPath": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
+"httpMethod": "DELETE",
+"id": "compute.rolloutPlans.delete",
+"parameterOrder": [
+"project",
+"rolloutPlan"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"rolloutPlan": {
+"description": "Name of the RolloutPlan resource to delete.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"get": {
+"description": "Gets details of a single project-scoped RolloutPlan.",
+"flatPath": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
 "httpMethod": "GET",
-"id": "compute.routers.aggregatedList",
+"id": "compute.rolloutPlans.get",
+"parameterOrder": [
+"project",
+"rolloutPlan"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"rolloutPlan": {
+"description": "Name of the persistent rollout plan to return.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
+"response": {
+"$ref": "RolloutPlan"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"insert": {
+"description": "Creates a new RolloutPlan in a given project and location.",
+"flatPath": "projects/{project}/global/rolloutPlans",
+"httpMethod": "POST",
+"id": "compute.rolloutPlans.insert",
+"parameterOrder": [
+"project"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rolloutPlans",
+"request": {
+"$ref": "RolloutPlan"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"list": {
+"description": "Lists RolloutPlans in a given project and location.",
+"flatPath": "projects/{project}/global/rolloutPlans",
+"httpMethod": "GET",
+"id": "compute.rolloutPlans.list",
 "parameterOrder": [
 "project"
 ],
@@ -41646,8 +41793,244 @@
 "location": "query",
 "type": "string"
 },
-"includeAllScopes": {
-"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
+"maxResults": {
+"default": "500",
+"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+"format": "uint32",
+"location": "query",
+"minimum": "0",
+"type": "integer"
+},
+"orderBy": {
+"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+"location": "query",
+"type": "string"
+},
+"pageToken": {
+"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "projects/{project}/global/rolloutPlans",
+"response": {
+"$ref": "RolloutPlansListResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+}
+}
+},
+"rollouts": {
+"methods": {
+"cancel": {
+"description": "Cancels a Rollout.",
+"flatPath": "projects/{project}/global/rollouts/{rollout}",
+"httpMethod": "PATCH",
+"id": "compute.rollouts.cancel",
+"parameterOrder": [
+"project",
+"rollout"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"rollback": {
+"description": "Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel\nthe rollout without taking any further actions. Note that products must\nsupport at least one of these options, however, it does not need to support\nboth.",
+"location": "query",
+"type": "boolean"
+},
+"rollout": {
+"description": "Name of the Rollout resource to cancel.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rollouts/{rollout}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"delete": {
+"description": "Deletes a Rollout.",
+"flatPath": "projects/{project}/global/rollouts/{rollout}",
+"httpMethod": "DELETE",
+"id": "compute.rollouts.delete",
+"parameterOrder": [
+"project",
+"rollout"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"rollout": {
+"description": "Name of the Rollout resource to delete.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rollouts/{rollout}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"get": {
+"description": "Gets details of a single project-scoped Rollout.",
+"flatPath": "projects/{project}/global/rollouts/{rollout}",
+"httpMethod": "GET",
+"id": "compute.rollouts.get",
+"parameterOrder": [
+"project",
+"rollout"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"rollout": {
+"description": "Name of the persistent rollout to return.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/rollouts/{rollout}",
+"response": {
+"$ref": "Rollout"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"list": {
+"description": "Lists Rollouts in a given project and location.",
+"flatPath": "projects/{project}/global/rollouts",
+"httpMethod": "GET",
+"id": "compute.rollouts.list",
+"parameterOrder": [
+"project"
+],
+"parameters": {
+"filter": {
+"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+"location": "query",
+"type": "string"
+},
+"maxResults": {
+"default": "500",
+"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+"format": "uint32",
+"location": "query",
+"minimum": "0",
+"type": "integer"
+},
+"orderBy": {
+"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+"location": "query",
+"type": "string"
+},
+"pageToken": {
+"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "projects/{project}/global/rollouts",
+"response": {
+"$ref": "RolloutsListResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+}
+}
+},
+"routers": {
+"methods": {
+"aggregatedList": {
+"description": "Retrieves an aggregated list of routers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"flatPath": "projects/{project}/aggregated/routers",
+"httpMethod": "GET",
+"id": "compute.routers.aggregatedList",
+"parameterOrder": [
+"project"
+],
+"parameters": {
+"filter": {
+"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+"location": "query",
+"type": "string"
+},
+"includeAllScopes": {
+"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
 "location": "query",
 "type": "boolean"
 },
@@ -46402,6 +46785,20 @@
 "format": "int64",
 "location": "query",
 "type": "string"
+},
+"views": {
+"description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n   \n   - WITH_UTILIZATION: Utilization data is included in the\n   response.",
+"enum": [
+"DEFAULT",
+"WITH_UTILIZATION"
+],
+"enumDescriptions": [
+"",
+"Utilization data is included in the response."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
 }
 },
 "path": "projects/{project}/aggregated/subnetworks",
@@ -52783,7 +53180,7 @@
 }
 }
 },
-"revision": "20250930",
+"revision": "20251019",
 "rootUrl": "https://compute.googleapis.com/",
 "schemas": {
 "AWSV4Signature": {
@@ -56234,7 +56631,7 @@ false
 "id": "BackendBucketCdnPolicyNegativeCachingPolicy",
 "properties": {
 "code": {
-"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
 "format": "int32",
 "type": "integer"
 },
@@ -56730,7 +57127,7 @@ false
 "type": "number"
 },
 "name": {
-"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
+"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
 "type": "string"
 }
 },
@@ -57384,7 +57781,7 @@ false
 "id": "BackendServiceCdnPolicyNegativeCachingPolicy",
 "properties": {
 "code": {
-"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
 "format": "int32",
 "type": "integer"
 },
@@ -57449,7 +57846,7 @@ false
 "type": "boolean"
 },
 "name": {
-"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
+"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
 "type": "string"
 }
 },
@@ -58127,7 +58524,7 @@ false
 "type": "string"
 },
 "identity": {
-"description": "Assigns the Managed Identity for the RegionBackendService Workload.\n\n\nUse this property to configure the load balancer back-end to use\ncertificates and roots of trust provisioned by the Managed Workload\nIdentity system. \n\n The `managedIdentity` property is the\nfully-specified SPIFFE ID to use in the SVID presented by the Load\nBalancer Workload. \n\n The SPIFFE ID must be a resource starting with the\n\"spiffe\" scheme identifier, followed by the \"trustDomain\" property value,\nfollowed by the path to the Managed Workload Identity. \n\n Supported\nSPIFFE ID format: \n   \n   - spiffe:///ns//sa/\n\n\nThe Trust Domain within the Managed Identity must refer to a valid\nWorkload Identity Pool. The TrustConfig and CertificateIssuanceConfig\nwill be inherited from the Workload Identity Pool. \n\n Restrictions: \n   \n   - If you set the `managedIdentity` property, you cannot manually set\n   the following fields: \n       - tlsSettings.sni\n      - tlsSettings.subjectAltNames\n      - tlsSettings.authenticationConfig\n   \n\nWhen defining a `managedIdentity` for a RegionBackendServices, the\ncorresponding Workload Identity Pool must have a ca_pool\nconfigured in the same region. \n\n The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.",
+"description": "Assigns the Managed Identity for the BackendService Workload.\n\n\nUse this property to configure the load balancer back-end to use\ncertificates and roots of trust provisioned by the Managed Workload\nIdentity system. \n\n The `identity` property is the\nfully-specified SPIFFE ID to use in the SVID presented by the Load\nBalancer Workload. \n\n The SPIFFE ID must be a resource starting with the\n`trustDomain` property value, followed by the path to the Managed\nWorkload Identity. \n\n Supported SPIFFE ID format: \n   \n   - ///ns//sa/\n\n\nThe Trust Domain within the Managed Identity must refer to a valid\nWorkload Identity Pool. The TrustConfig and CertificateIssuanceConfig\nwill be inherited from the Workload Identity Pool. \n\n Restrictions: \n   \n   - If you set the `identity` property, you cannot manually set\n   the following fields: \n       - tlsSettings.sni\n      - tlsSettings.subjectAltNames\n      - tlsSettings.authenticationConfig\n   \n\nWhen defining a `identity` for a RegionBackendServices, the\ncorresponding Workload Identity Pool must have a ca_pool\nconfigured in the same region. \n\n The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.",
 "type": "string"
 },
 "sni": {
@@ -59160,7 +59557,7 @@ false
 "type": "number"
 },
 "uptimeScore": {
-"description": "The uptime score indicates the availability of your Spot VMs. For more\ninformation about the preemption process, see Preemption\nof Spot VMs.\nThe score range is 0.0 through 1.0. Higher is better.",
+"description": "The uptime score indicates the likelihood that your Spot VMs will\ncontinue to run without preemption within the next few hours. For more\ninformation about the preemption process, see Preemption\nof Spot VMs.\nThe score range is 0.0 through 1.0. Higher is better.",
 "format": "double",
 "type": "number"
 }
@@ -59377,12 +59774,14 @@ false
 "INVALID",
 "SIXTY_MONTH",
 "THIRTY_SIX_MONTH",
-"TWELVE_MONTH"
+"TWELVE_MONTH",
+"TWENTY_FOUR_MONTH"
 ],
 "enumDescriptions": [
 "",
 "",
 "",
+"",
 ""
 ],
 "type": "string"
@@ -63866,6 +64265,7 @@ false
 "policyType": {
 "description": "The type of the firewall policy. This field can be eitherVPC_POLICY or RDMA_ROCE_POLICY.\n\nNote: if not specified then VPC_POLICY will be used.",
 "enum": [
+"RDMA_FALCON_POLICY",
 "RDMA_ROCE_POLICY",
 "ULL_POLICY",
 "VPC_POLICY"
@@ -63873,6 +64273,7 @@ false
 "enumDescriptions": [
 "",
 "",
+"",
 ""
 ],
 "type": "string"
@@ -65434,12 +65835,14 @@ false
 "INVALID",
 "SIXTY_MONTH",
 "THIRTY_SIX_MONTH",
-"TWELVE_MONTH"
+"TWELVE_MONTH",
+"TWENTY_FOUR_MONTH"
 ],
 "enumDescriptions": [
 "",
 "",
 "",
+"",
 ""
 ],
 "type": "string"
@@ -67783,51 +68186,46 @@ false
 },
 "type": "object"
 },
-"HaControllersFailoverRequest": {
-"id": "HaControllersFailoverRequest",
-"properties": {
-"primaryZone": {
-"description": "Name of the destination zone for the failover.",
-"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
-"type": "string"
-}
-},
-"type": "object"
-},
-"HaControllersList": {
-"id": "HaControllersList",
+"HaControllersAggregatedList": {
+"id": "HaControllersAggregatedList",
 "properties": {
 "etag": {
 "type": "string"
 },
 "id": {
-"description": "Unique identifier for the resource; defined by the server.",
+"description": "[Output Only] Unique identifier for the resource; defined by the server.",
 "type": "string"
 },
 "items": {
-"description": "A list of HaControllers in the specified project and region.",
-"items": {
-"$ref": "HaController"
+"additionalProperties": {
+"$ref": "HaControllersScopedList",
+"description": "Name of the scope containing this set of ha controllers."
 },
-"type": "array"
+"description": "A list of HaControllersScopedList resources.",
+"type": "object"
+},
+"kind": {
+"default": "compute#haControllersAggregatedList",
+"description": "[Output Only] Type of resource. Alwayscompute#haControllersAggregatedList for lists of\nHaControllers.",
+"type": "string"
 },
 "nextPageToken": {
-"description": "This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
 "type": "string"
 },
 "selfLink": {
-"description": "[Output only] Server-defined URL for this resource.",
+"description": "[Output Only] Server-defined URL for this resource.",
 "type": "string"
 },
 "unreachables": {
-"description": "[Output only] Unreachable resources.",
+"description": "[Output Only] Unreachable resources.",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "warning": {
-"description": "Informational warning message.",
+"description": "[Output Only] Informational warning message.",
 "properties": {
 "code": {
 "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
@@ -67953,18 +68351,57 @@ false
 },
 "type": "object"
 },
-"HealthAggregationPoliciesScopedList": {
-"id": "HealthAggregationPoliciesScopedList",
+"HaControllersFailoverRequest": {
+"id": "HaControllersFailoverRequest",
 "properties": {
-"healthAggregationPolicies": {
-"description": "A list of HealthAggregationPolicys contained in this scope.",
+"failoverToZone": {
+"description": "Name of the destination zone for the failover.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+},
+"primaryZone": {
+"deprecated": true,
+"description": "Name of the destination zone for the failover.\nDeprecated: use failover_to_zone instead.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+}
+},
+"type": "object"
+},
+"HaControllersList": {
+"id": "HaControllersList",
+"properties": {
+"etag": {
+"type": "string"
+},
+"id": {
+"description": "Unique identifier for the resource; defined by the server.",
+"type": "string"
+},
 "items": {
-"$ref": "HealthAggregationPolicy"
+"description": "A list of HaControllers in the specified project and region.",
+"items": {
+"$ref": "HaController"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "This token allows you to get the next page of results formaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output only] Server-defined URL for this resource.",
+"type": "string"
+},
+"unreachables": {
+"description": "[Output only] Unreachable resources.",
+"items": {
+"type": "string"
 },
 "type": "array"
 },
 "warning": {
-"description": "Informational warning which replaces the list of health aggregation\npolicies when the list is empty.",
+"description": "Informational warning message.",
 "properties": {
 "code": {
 "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
@@ -68090,113 +68527,387 @@ false
 },
 "type": "object"
 },
-"HealthAggregationPolicy": {
-"description": "Represents a health aggregation policy.\n\nA health aggregation policy resource defines a policy to aggregate health.\n\nFor more information, see\nHealth checks overview.",
-"id": "HealthAggregationPolicy",
-"properties": {
-"creationTimestamp": {
-"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
-"type": "string"
-},
-"description": {
-"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
-"type": "string"
-},
-"fingerprint": {
-"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthAggregationPolicy. An up-to-date fingerprint\nmust be provided in order to patch the HealthAggregationPolicy; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nHealthAggregationPolicy.",
-"format": "byte",
-"type": "string"
-},
-"healthyPercentThreshold": {
-"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a\npercentage) of healthy endpoints required in order to consider the\naggregated health result HEALTHY. Defaults to 60. Must be in\nrange [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and minHealthyThreshold must be satisfied in order\nfor HEALTHY to be the aggregated result. \"Endpoints\" refers to network\nendpoints within a Network Endpoint Group or instances within an Instance\nGroup.",
-"format": "uint32",
-"type": "integer"
-},
-"id": {
-"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
-"format": "uint64",
-"type": "string"
-},
-"kind": {
-"default": "compute#healthAggregationPolicy",
-"description": "[Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.",
-"type": "string"
-},
-"minHealthyThreshold": {
-"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of\nhealthy endpoints required in order to consider the aggregated health\nresult HEALTHY. Defaults to 1. Must be positive. Not\napplicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and healthyPercentThreshold must be satisfied in\norder for HEALTHY to be the aggregated result. \"Endpoints\" refers to\nnetwork endpoints within a Network Endpoint Group or instances within an\nInstance Group.",
-"format": "uint32",
-"type": "integer"
-},
-"name": {
-"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
-"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
-"type": "string"
-},
-"policyType": {
-"description": "Specifies the type of the healthAggregationPolicy. The only allowed value\nfor global resources is DNS_PUBLIC_IP_POLICY. The only allowed\nvalue for regional resources is BACKEND_SERVICE_POLICY. Must\nbe specified when the healthAggregationPolicy is created, and cannot be\nmutated.",
-"enum": [
-"BACKEND_SERVICE_POLICY",
-"DNS_PUBLIC_IP_POLICY"
-],
-"enumDescriptions": [
-"",
-""
-],
-"type": "string"
-},
-"region": {
-"description": "[Output Only] URL of the region where the health aggregation policy\nresides. This field applies only to the regional resource. You must specify\nthis field as part of the HTTP request URL. It is not settable as a field\nin the request body.",
-"type": "string"
-},
-"selfLink": {
-"description": "[Output Only] Server-defined URL for the resource.",
-"type": "string"
-},
-"selfLinkWithId": {
-"description": "[Output Only] Server-defined URL with id for the resource.",
-"type": "string"
-}
-},
-"type": "object"
-},
-"HealthAggregationPolicyAggregatedList": {
-"description": "Contains a list of HealthAggregationPoliciesScopedList.",
-"id": "HealthAggregationPolicyAggregatedList",
+"HaControllersScopedList": {
+"id": "HaControllersScopedList",
 "properties": {
-"id": {
-"description": "[Output Only] Unique identifier for the resource; defined by the server.",
-"type": "string"
-},
-"items": {
-"additionalProperties": {
-"$ref": "HealthAggregationPoliciesScopedList",
-"description": "Name of the scope containing this set of HealthAggregationPolicies."
-},
-"description": "A list of HealthAggregationPoliciesScopedList resources.",
-"type": "object"
-},
-"kind": {
-"default": "compute#healthAggregationPolicyAggregatedList",
-"description": "Type of resource.",
-"type": "string"
-},
-"nextPageToken": {
-"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
-"type": "string"
-},
-"selfLink": {
-"description": "[Output Only] Server-defined URL for this resource.",
-"type": "string"
-},
-"unreachables": {
-"description": "[Output Only] Unreachable resources.",
+"haControllers": {
+"description": "List of HaControllers contained in this scope.",
 "items": {
-"type": "string"
+"$ref": "HaController"
 },
 "type": "array"
 },
 "warning": {
-"description": "[Output Only] Informational warning message.",
+"description": "Informational warning which replaces the list of\nbackend services when the list is empty.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"HealthAggregationPoliciesScopedList": {
+"id": "HealthAggregationPoliciesScopedList",
+"properties": {
+"healthAggregationPolicies": {
+"description": "A list of HealthAggregationPolicys contained in this scope.",
+"items": {
+"$ref": "HealthAggregationPolicy"
+},
+"type": "array"
+},
+"warning": {
+"description": "Informational warning which replaces the list of health aggregation\npolicies when the list is empty.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"HealthAggregationPolicy": {
+"description": "Represents a health aggregation policy.\n\nA health aggregation policy resource defines a policy to aggregate health.\n\nFor more information, see\nHealth checks overview.",
+"id": "HealthAggregationPolicy",
+"properties": {
+"creationTimestamp": {
+"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
+"type": "string"
+},
+"description": {
+"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
+"type": "string"
+},
+"fingerprint": {
+"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthAggregationPolicy. An up-to-date fingerprint\nmust be provided in order to patch the HealthAggregationPolicy; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nHealthAggregationPolicy.",
+"format": "byte",
+"type": "string"
+},
+"healthyPercentThreshold": {
+"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a\npercentage) of healthy endpoints required in order to consider the\naggregated health result HEALTHY. Defaults to 60. Must be in\nrange [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and minHealthyThreshold must be satisfied in order\nfor HEALTHY to be the aggregated result. \"Endpoints\" refers to network\nendpoints within a Network Endpoint Group or instances within an Instance\nGroup.",
+"format": "uint32",
+"type": "integer"
+},
+"id": {
+"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+"format": "uint64",
+"type": "string"
+},
+"kind": {
+"default": "compute#healthAggregationPolicy",
+"description": "[Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.",
+"type": "string"
+},
+"minHealthyThreshold": {
+"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of\nhealthy endpoints required in order to consider the aggregated health\nresult HEALTHY. Defaults to 1. Must be positive. Not\napplicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and healthyPercentThreshold must be satisfied in\norder for HEALTHY to be the aggregated result. \"Endpoints\" refers to\nnetwork endpoints within a Network Endpoint Group or instances within an\nInstance Group.",
+"format": "uint32",
+"type": "integer"
+},
+"name": {
+"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+},
+"policyType": {
+"description": "Specifies the type of the healthAggregationPolicy. The only allowed value\nfor global resources is DNS_PUBLIC_IP_POLICY. The only allowed\nvalue for regional resources is BACKEND_SERVICE_POLICY. Must\nbe specified when the healthAggregationPolicy is created, and cannot be\nmutated.",
+"enum": [
+"BACKEND_SERVICE_POLICY",
+"DNS_PUBLIC_IP_POLICY"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
+"region": {
+"description": "[Output Only] URL of the region where the health aggregation policy\nresides. This field applies only to the regional resource. You must specify\nthis field as part of the HTTP request URL. It is not settable as a field\nin the request body.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined URL for the resource.",
+"type": "string"
+},
+"selfLinkWithId": {
+"description": "[Output Only] Server-defined URL with id for the resource.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"HealthAggregationPolicyAggregatedList": {
+"description": "Contains a list of HealthAggregationPoliciesScopedList.",
+"id": "HealthAggregationPolicyAggregatedList",
+"properties": {
+"id": {
+"description": "[Output Only] Unique identifier for the resource; defined by the server.",
+"type": "string"
+},
+"items": {
+"additionalProperties": {
+"$ref": "HealthAggregationPoliciesScopedList",
+"description": "Name of the scope containing this set of HealthAggregationPolicies."
+},
+"description": "A list of HealthAggregationPoliciesScopedList resources.",
+"type": "object"
+},
+"kind": {
+"default": "compute#healthAggregationPolicyAggregatedList",
+"description": "Type of resource.",
+"type": "string"
+},
+"nextPageToken": {
+"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined URL for this resource.",
+"type": "string"
+},
+"unreachables": {
+"description": "[Output Only] Unreachable resources.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"warning": {
+"description": "[Output Only] Informational warning message.",
 "properties": {
 "code": {
 "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
@@ -71710,9 +72421,11 @@ false
 "type": "string"
 },
 "identity": {
+"deprecated": true,
 "type": "string"
 },
 "identityCertificate": {
+"deprecated": true,
 "type": "boolean"
 },
 "instanceEncryptionKey": {
@@ -71964,6 +72677,9 @@ false
 "$ref": "UpcomingMaintenance",
 "description": "[Output Only] DEPRECATED: Please useresource_status.upcoming_maintenance instead. Specifies\nupcoming maintenance for the instance."
 },
+"workloadIdentityConfig": {
+"$ref": "WorkloadIdentityConfig"
+},
 "zone": {
 "description": "[Output Only] URL of the zone where the instance resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
 "type": "string"
@@ -73145,6 +73861,13 @@ false
 "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": {
 "id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection",
 "properties": {
+"disks": {
+"description": "List of disks to be attached to the instances created from this\nselection.",
+"items": {
+"$ref": "AttachedDisk"
+},
+"type": "array"
+},
 "machineTypes": {
 "description": "Full machine-type names, e.g. \"n1-standard-16\".",
 "items": {
@@ -73152,6 +73875,10 @@ false
 },
 "type": "array"
 },
+"minCpuPlatform": {
+"description": "Name of the minimum CPU platform to be used by this instance selection.\ne.g. 'Intel Ice Lake'.",
+"type": "string"
+},
 "rank": {
 "description": "Preference of this instance selection. Lower number means higher\npreference. MIG will first try to create a VM based on the machine-type\nwith lowest rank and fallback to next rank based on availability.\nMachine types and instance selections with the same rank have the same\npreference.",
 "format": "int32",
@@ -73248,7 +73975,7 @@ false
 "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair",
 "properties": {
 "allowChangingZone": {
-"description": "Specifies whether the MIG can change a VM's zone during a repair.",
+"description": "Specifies whether the MIG can change a VM's zone during a repair.\nValid values are:\n   \n   - NO (default): MIG cannot change a VM's zone during a\n   repair.\n   - YES: MIG can select a different zone for the VM during\n   a repair.",
 "enum": [
 "NO",
 "YES"
@@ -75590,9 +76317,11 @@ false
 "type": "array"
 },
 "identity": {
+"deprecated": true,
 "type": "string"
 },
 "identityCertificate": {
+"deprecated": true,
 "type": "boolean"
 },
 "keyRevocationActionType": {
@@ -75733,6 +76462,9 @@ false
 "tags": {
 "$ref": "Tags",
 "description": "A list of tags to apply to the instances that are created from these\nproperties. The tags identify valid sources or targets for network\nfirewalls. The setTags method can modify this list of tags. Each tag within\nthe list must comply with RFC1035."
+},
+"workloadIdentityConfig": {
+"$ref": "WorkloadIdentityConfig"
 }
 },
 "type": "object"
@@ -78193,7 +78925,7 @@ false
 "type": "integer"
 },
 "type": {
-"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.",
+"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.",
 "enum": [
 "DEDICATED",
 "L2_DEDICATED",
@@ -78202,7 +78934,7 @@ false
 ],
 "enumDescriptions": [
 "Attachment to a dedicated interconnect.",
-"Attachment to a L2 interconnect, created by the customer.",
+"Attachment to a dedicated interconnect, forwarding L2 packets.",
 "Attachment to a partner interconnect, created by the customer.",
 "Attachment to a partner interconnect, created by the partner."
 ],
@@ -78912,7 +79644,7 @@ false
 ],
 "enumDescriptions": [
 "Attachment to a dedicated interconnect.",
-"Attachment to a L2 interconnect, created by the customer.",
+"Attachment to a dedicated interconnect, forwarding L2 packets.",
 "Attachment to a partner interconnect, created by the customer.",
 "Attachment to a partner interconnect, created by the partner."
 ],
@@ -79852,7 +80584,7 @@ false
 "type": "string"
 },
 "etag": {
-"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAPI 154.",
+"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.",
 "type": "string"
 },
 "id": {
@@ -83900,10 +84632,21 @@ false
 "ManagedInstanceInstanceFlexibilityOverride": {
 "id": "ManagedInstanceInstanceFlexibilityOverride",
 "properties": {
+"disks": {
+"description": "List of disks to be attached to the instance.",
+"items": {
+"$ref": "AttachedDisk"
+},
+"type": "array"
+},
 "machineType": {
 "description": "The machine type to be used for this instance.",
 "type": "string"
 },
+"minCpuPlatform": {
+"description": "Name of the minimum CPU platform to be used by this instance.\ne.g. 'Intel Ice Lake'.",
+"type": "string"
+},
 "provisioningModel": {
 "description": "The provisioning model to be used for this instance.",
 "enum": [
@@ -88493,6 +89236,18 @@ false
 },
 "type": "array"
 },
+"allowAddressCreation": {
+"description": "Specifies whether address creation is allowed.",
+"enum": [
+"ADDRESS_CREATION_ALLOWED",
+"ADDRESS_CREATION_BLOCKED"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "allowAliasIpRanges": {
 "description": "Specifies whether alias IP ranges (and secondary address ranges) are\nallowed.",
 "enum": [
@@ -88637,6 +89392,30 @@ false
 ],
 "type": "string"
 },
+"allowMultiNicInSameSubnetwork": {
+"description": "Specifies whether multi-nic in the same subnetwork is allowed.",
+"enum": [
+"MULTI_NIC_IN_SAME_SUBNETWORK_ALLOWED",
+"MULTI_NIC_IN_SAME_SUBNETWORK_BLOCKED"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
+"allowMulticast": {
+"description": "Specifies whether multicast is allowed.",
+"enum": [
+"MULTICAST_ALLOWED",
+"MULTICAST_BLOCKED"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "allowNcc": {
 "description": "Specifies whether NCC is allowed.",
 "enum": [
@@ -88733,6 +89512,18 @@ false
 ],
 "type": "string"
 },
+"allowSubnetworkCreation": {
+"description": "Specifies whether subnetwork creation is allowed.",
+"enum": [
+"SUBNETWORK_CREATION_ALLOWED",
+"SUBNETWORK_CREATION_BLOCKED"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "allowVpcFirewallRules": {
 "description": "Specifies whether VPC firewall rules can be created under the network.",
 "enum": [
@@ -88772,6 +89563,7 @@ false
 "firewallPolicyTypes": {
 "items": {
 "enum": [
+"RDMA_FALCON_POLICY",
 "RDMA_ROCE_POLICY",
 "ULL_POLICY",
 "VPC_POLICY"
@@ -88779,6 +89571,7 @@ false
 "enumDescriptions": [
 "",
 "",
+"",
 ""
 ],
 "type": "string"
@@ -88808,6 +89601,29 @@ false
 },
 "type": "array"
 },
+"multicast": {
+"description": "Specifies which type of multicast is supported.",
+"enum": [
+"MULTICAST_SDN",
+"MULTICAST_ULL"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
+"predefinedNetworkInternalIpv6Range": {
+"description": "Specifies a predefined internal IPv6 range for the network.",
+"type": "string"
+},
+"predefinedSubnetworkRanges": {
+"description": "Predefined subnetwork ranges for the network.",
+"items": {
+"$ref": "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange"
+},
+"type": "array"
+},
 "subnetPurposes": {
 "description": "Specifies which subnetwork purposes are supported.",
 "items": {
@@ -88905,6 +89721,20 @@ false
 },
 "type": "object"
 },
+"NetworkProfileNetworkFeaturesPredefinedSubnetworkRange": {
+"id": "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange",
+"properties": {
+"ipv6Range": {
+"description": "The IPv6 range of the predefined subnetwork.",
+"type": "string"
+},
+"namePrefix": {
+"description": "The naming prefix of the predefined subnetwork.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "NetworkProfileProfileType": {
 "id": "NetworkProfileProfileType",
 "properties": {
@@ -100904,12 +101734,14 @@ false
 "FAULT_BEHAVIOR_UNSPECIFIED",
 "GPU_ERROR",
 "PERFORMANCE",
+"SILENT_DATA_CORRUPTION",
 "SWITCH_FAILURE"
 ],
 "enumDescriptions": [
 "",
 "The subBlock experienced a GPU error.",
 "The subBlock experienced performance issues.",
+"The subBlock experienced silent data corruption.",
 "The subBlock experienced a switch failure."
 ],
 "type": "string"
@@ -101581,6 +102413,18 @@ false
 "description": "A GroupPlacementPolicy specifies resource placement configuration.\nIt specifies the failure bucket separation",
 "id": "ResourcePolicyGroupPlacementPolicy",
 "properties": {
+"acceleratorTopologyMode": {
+"description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.",
+"enum": [
+"AUTO_CONNECT",
+"PROVISION_ONLY"
+],
+"enumDescriptions": [
+"The interconnected chips are pre-configured at the time of VM creation.",
+"The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected."
+],
+"type": "string"
+},
 "availabilityDomainCount": {
 "description": "The number of availability domains to spread instances across. If two\ninstances are in different availability domain, they are not in the same\nlow latency network.",
 "format": "int32",
@@ -102556,6 +103400,530 @@ false
 },
 "type": "object"
 },
+"Rollout": {
+"description": "Represent a Rollout resource.",
+"id": "Rollout",
+"properties": {
+"cancellationTime": {
+"description": "Output only. The timestamp at which the Rollout was cancelled.",
+"readOnly": true,
+"type": "string"
+},
+"completionTime": {
+"description": "Output only. The timestamp at which the Rollout was completed.",
+"readOnly": true,
+"type": "string"
+},
+"creationTimestamp": {
+"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
+"type": "string"
+},
+"currentWaveNumber": {
+"description": "Output only. The number of the currently running wave.\nEx. 1",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"description": {
+"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
+"type": "string"
+},
+"etag": {
+"description": "Output only. etag of the Rollout\nEx. abc1234",
+"readOnly": true,
+"type": "string"
+},
+"id": {
+"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+"format": "uint64",
+"type": "string"
+},
+"kind": {
+"default": "compute#rollout",
+"description": "[Output Only] Type of the resource. Always compute#rollout\nfor rollouts.",
+"type": "string"
+},
+"name": {
+"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+},
+"rolloutEntity": {
+"$ref": "RolloutRolloutEntity",
+"description": "Required. The resource being rolled out."
+},
+"rolloutPlan": {
+"description": "Required. Rollout Plan used to model the Rollout.\nEx. progressiverollout.googleapis.com/v1/organizations/1/rolloutPlans\nEx. progressiverollout.googleapis.com/v1/folders/1/rolloutPlans",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
+"type": "string"
+},
+"selfLinkWithId": {
+"description": "[Output Only] Server-defined URL for this resource's resource id.",
+"type": "string"
+},
+"state": {
+"description": "Output only. The current state of the Rollout.",
+"enum": [
+"CANCELLED",
+"CANCELLING",
+"CANCEL_FAILED",
+"COMPLETED",
+"COMPLETE_FAILED",
+"COMPLETING",
+"FAILED",
+"PAUSED",
+"PAUSE_FAILED",
+"PAUSING",
+"PROCESSING",
+"READY",
+"RESUMING",
+"ROLLBACK_WAVE_FAILED",
+"ROLLING_BACK",
+"STATE_UNSPECIFIED",
+"UNINITIALIZED",
+"WAVE_FAILED"
+],
+"enumDescriptions": [
+"The rollout is in a failure terminal state.",
+"The rollout is being cancelled.",
+"An attempted cancel operation was unsuccessful.",
+"The rollout is in a successful terminal state.",
+"An attempted complete operation was unsuccessful.",
+"The rollout is being marked as completed.",
+"The rollout completed with failures.",
+"The rollout is paused.",
+"An attempted pause operation was unsuccessful.",
+"The rollout is being paused.",
+"A wave is being processed by the product.",
+"The rollout has been successfully initialized and is ready to start.",
+"The rollout is being resumed after being paused.",
+"An attempted rollback operation failed to complete successfully.",
+"A wave rollback is in progress for this rollout.",
+"Undefined default state. Should never be exposed to users.",
+"The rollout has been created but is not yet ready to be started.",
+"The product failed to process the wave."
+],
+"readOnly": true,
+"type": "string"
+},
+"waveDetails": {
+"description": "Output only. Details about each wave of the rollout.",
+"items": {
+"$ref": "RolloutWaveDetails"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
+"RolloutPlan": {
+"description": "Message describing RolloutPlan object",
+"id": "RolloutPlan",
+"properties": {
+"creationTimestamp": {
+"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
+"type": "string"
+},
+"description": {
+"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
+"type": "string"
+},
+"id": {
+"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+"format": "uint64",
+"type": "string"
+},
+"kind": {
+"default": "compute#rolloutPlan",
+"description": "[Output Only] Type of the resource. Always compute#rolloutPlan\nfor rolloutPlans.",
+"type": "string"
+},
+"locationScope": {
+"description": "The location scope of the rollout plan. If not specified, the location\nscope is considered as ZONAL.",
+"enum": [
+"LOCATION_SCOPE_UNSPECIFIED",
+"REGIONAL",
+"ZONAL"
+],
+"enumDescriptions": [
+"Unspecified value. Considered as ZONAL.",
+"Regional scope.",
+"Zonal scope."
+],
+"type": "string"
+},
+"name": {
+"annotations": {
+"required": [
+"compute.rolloutPlans.insert"
+]
+},
+"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
+"type": "string"
+},
+"selfLinkWithId": {
+"description": "[Output Only] Server-defined URL for this resource's resource id.",
+"type": "string"
+},
+"waves": {
+"description": "Required. The waves included in this rollout plan.",
+"items": {
+"$ref": "RolloutPlanWave"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"RolloutPlanWave": {
+"description": "A single wave in a rollout plan.",
+"id": "RolloutPlanWave",
+"properties": {
+"displayName": {
+"description": "Optional. The display name of this wave of the rollout plan.",
+"type": "string"
+},
+"number": {
+"description": "Output only. The wave number.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"orchestrationOptions": {
+"$ref": "RolloutPlanWaveOrchestrationOptions",
+"description": "Optional. The orchestration options for this wave."
+},
+"selectors": {
+"description": "Required. The selectors for this wave. There is a logical AND between each selector\ndefined in a wave, so a resource must satisfy the criteria of *all* the\nspecified selectors to be in scope for the wave.",
+"items": {
+"$ref": "RolloutPlanWaveSelector"
+},
+"type": "array"
+},
+"validation": {
+"$ref": "RolloutPlanWaveValidation",
+"description": "Required. The validation to be performed at the end of this wave."
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveOrchestrationOptions": {
+"description": "Options to control the pace of orchestration of a wave. These options are\nrequired only if the resource being rolled out follows the Orchestrated\npattern.",
+"id": "RolloutPlanWaveOrchestrationOptions",
+"properties": {
+"delays": {
+"description": "Optional. Delays, if any, to be added between batches of projects. We allow\nmultiple Delays to be specified, letting users set separate delays\nbetween batches of projects corresponding to different locations and\nbatches of projects corresponding to the same location.",
+"items": {
+"$ref": "RolloutPlanWaveOrchestrationOptionsDelay"
+},
+"type": "array"
+},
+"maxConcurrentLocations": {
+"description": "Optional. Maximum number of locations to be orchestrated in parallel.",
+"format": "int64",
+"type": "string"
+},
+"maxConcurrentResourcesPerLocation": {
+"description": "Optional. Maximum number of resources to be orchestrated per location in\nparallel.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveOrchestrationOptionsDelay": {
+"description": "Options to control the delay, if any, between batches of projects.",
+"id": "RolloutPlanWaveOrchestrationOptionsDelay",
+"properties": {
+"delimiter": {
+"description": "Optional. Controls whether the delay should only be added between batches of\nprojects corresponding to different locations, or also between\nbatches of projects corresponding to the same location.\n\nMust be set to DELIMITER_UNSPECIFIED if no delay is to be added.",
+"enum": [
+"DELIMITER_BATCH",
+"DELIMITER_LOCATION",
+"DELIMITER_UNSPECIFIED"
+],
+"enumDescriptions": [
+"The delay will also be added between batches of projects\ncorresponding to the same location.",
+"The delay will only be added between batches of projects\ncorresponding to different locations.",
+"No delay will be added between batches of projects. Processing will\ncontinue with the next batch as soon as the previous batch of LROs\nis done."
+],
+"type": "string"
+},
+"duration": {
+"description": "Optional. The duration of the delay, if any, to be added between batches of\nprojects. A zero duration corresponds to no delay.",
+"format": "google-duration",
+"type": "string"
+},
+"type": {
+"description": "Optional. Controls whether the specified duration is to be added at the end of\neach batch, or if the total processing time for each batch will be\npadded if needed to meet the specified duration.\n\nMust be set to TYPE_UNSPECIFIED if no delay is to be added.",
+"enum": [
+"TYPE_MINIMUM",
+"TYPE_OFFSET",
+"TYPE_UNSPECIFIED"
+],
+"enumDescriptions": [
+"The total processing time for each batch of projects will be padded\nif needed to meet the specified delay duration.",
+"The specified delay will directly be added after each batch of\nprojects as specified by the delimiter.",
+"No delay will be added between batches of projects. Processing will\ncontinue with the next batch as soon as the previous batch of LROs\nis done."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveSelector": {
+"description": "A selector which specifies what resource(s) are included in a given wave.",
+"id": "RolloutPlanWaveSelector",
+"properties": {
+"locationSelector": {
+"$ref": "RolloutPlanWaveSelectorLocationSelector",
+"description": "Optional. Roll out to resources by Cloud locations."
+},
+"resourceHierarchySelector": {
+"$ref": "RolloutPlanWaveSelectorResourceHierarchySelector",
+"description": "Optional. Roll out to resources by Cloud Resource Manager resource hierarchy."
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveSelectorLocationSelector": {
+"description": "Roll out to resources by location.",
+"id": "RolloutPlanWaveSelectorLocationSelector",
+"properties": {
+"includedLocations": {
+"description": "Optional. Example: \"us-central1-a\"",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveSelectorResourceHierarchySelector": {
+"description": "Roll out to resources by Cloud Resource Manager resource hierarchy\nnodes such as projects, folders, orgs.",
+"id": "RolloutPlanWaveSelectorResourceHierarchySelector",
+"properties": {
+"includedFolders": {
+"description": "Optional. Format: \"folders/{folder_id}\"",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"includedOrganizations": {
+"description": "Optional. Format: \"organizations/{organization_id}\"",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"includedProjects": {
+"description": "Optional. Format: \"projects/{project_id}\"",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveValidation": {
+"description": "The validation to be performed before progressing to the next wave.",
+"id": "RolloutPlanWaveValidation",
+"properties": {
+"timeBasedValidationMetadata": {
+"$ref": "RolloutPlanWaveValidationTimeBasedValidationMetadata",
+"description": "Optional. Metadata required if type = \"time\"."
+},
+"type": {
+"description": "Required. The type of the validation. If a type of validation is associated with\na metadata object, the appropriate metadata field mapping to the\nvalidation type must be provided in the validation message. Possible\nvalues are in quotes below alongside an explanation:\n  \"manual\": The system waits for an end-user approval API before\n    progressing to the next wave.\n  \"time\": The system waits for a user specified duration before\n    progressing to the next wave. TimeBasedValidation must be provided.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutPlanWaveValidationTimeBasedValidationMetadata": {
+"description": "Metadata required if type = \"time\".",
+"id": "RolloutPlanWaveValidationTimeBasedValidationMetadata",
+"properties": {
+"waitDuration": {
+"description": "Optional. The duration that the system waits in between waves. This wait starts\nafter all changes in the wave are rolled out.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutPlansListResponse": {
+"description": "Contains a list of RolloutPlan resources.",
+"id": "RolloutPlansListResponse",
+"properties": {
+"etag": {
+"type": "string"
+},
+"id": {
+"description": "[Output Only] Unique identifier for the resource; defined by the server.",
+"type": "string"
+},
+"items": {
+"description": "A list of RolloutPlan resources.",
+"items": {
+"$ref": "RolloutPlan"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined URL for this resource.",
+"type": "string"
+},
+"unreachables": {
+"description": "[Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"warning": {
+"description": "[Output Only] Informational warning message.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
 "RolloutPolicy": {
 "description": "A rollout policy configuration.",
 "id": "RolloutPolicy",
@@ -102574,6 +103942,251 @@ false
 },
 "type": "object"
 },
+"RolloutRolloutEntity": {
+"description": "Specifications of the resource to roll out.",
+"id": "RolloutRolloutEntity",
+"properties": {
+"orchestratedEntity": {
+"$ref": "RolloutRolloutEntityOrchestratedEntity",
+"description": "Optional. Entity details for products using the Orchestrated Integration model."
+}
+},
+"type": "object"
+},
+"RolloutRolloutEntityOrchestratedEntity": {
+"description": "This message is used if the resource type follows the Orchestrated\nintegration model with ProgressiveRollout.",
+"id": "RolloutRolloutEntityOrchestratedEntity",
+"properties": {
+"conflictBehavior": {
+"description": "Required. Specifies the behavior of the Rollout if an out of band update is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) overwrite : Overwrite the local value with the rollout value.\n2) no_overwrite : Do not overwrite the local value with the rollout\nvalue.",
+"type": "string"
+},
+"orchestrationAction": {
+"description": "Required. Orchestration action during the Rollout. It can be one of the following\nvalues:\n1) \"update\": Resources will be updated by the rollout.\n2) \"delete\": Resources will be deleted by the rollout.",
+"type": "string"
+},
+"orchestrationSource": {
+"description": "Required. Fully qualified resource name of the resource which contains the source\nof truth of the configuration being rolled out across\nlocations/projects. For example, in the case of a global Rollout which\nis applied across regions, this contains the name of the global\nresource created by the user which contains a payload for a resource\nthat is orchestrated across regions. This follows the following format:\n//.googleapis.com/organizations//locations/global//\ne.g.\n//osconfig.googleapis.com/organizations/1/locations/global/policyOrchestrators/po1",
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutWaveDetails": {
+"description": "Additional metadata about the status of each wave provided by the server.",
+"id": "RolloutWaveDetails",
+"properties": {
+"orchestratedWaveDetails": {
+"$ref": "RolloutWaveDetailsOrchestratedWaveDetails",
+"description": "Output only. Additional details of the wave for products using the Orchestrated\nIntegration model.",
+"readOnly": true
+},
+"waveDisplayName": {
+"description": "Output only. Wave name.\nEx. wave1",
+"readOnly": true,
+"type": "string"
+},
+"waveNumber": {
+"description": "Output only. System generated number for the wave.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutWaveDetailsOrchestratedWaveDetails": {
+"description": "Details of the wave for products using the Orchestrated integration\nmodel.",
+"id": "RolloutWaveDetailsOrchestratedWaveDetails",
+"properties": {
+"completedResourcesCount": {
+"description": "Output only. Resource completed so far.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"estimatedTotalResourcesCount": {
+"description": "Output only. Estimated total count of resources.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"failedLocations": {
+"description": "Output only. Locations that failed during orchestration, and ProgressiveRollout\nstopped retrying. There may be some successful resources rolled out in\nthe wave as the location may have failed later in the Rollout.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"failedResourcesCount": {
+"description": "Output only. Resources failed.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"RolloutsListResponse": {
+"id": "RolloutsListResponse",
+"properties": {
+"etag": {
+"type": "string"
+},
+"id": {
+"description": "[Output Only] Unique identifier for the resource; defined by the server.",
+"type": "string"
+},
+"items": {
+"description": "A list of Rollout resources.",
+"items": {
+"$ref": "Rollout"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined URL for this resource.",
+"type": "string"
+},
+"unreachables": {
+"description": "[Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"warning": {
+"description": "[Output Only] Informational warning message.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
 "Route": {
 "description": "Represents a Route resource.\n\nA route defines a path from VM instances in the VPC network to a specific\ndestination. This destination can be inside or outside the VPC network.\nFor more information, read theRoutes overview.",
 "id": "Route",
@@ -102722,7 +104335,7 @@ false
 "type": "integer"
 },
 "routeStatus": {
-"description": "[Output only] The status of the route.",
+"description": "[Output only] The status of the route. This status only applies to\ndynamic routes learned by Cloud Routers. This status is not applicable\nto static routes.",
 "enum": [
 "ACTIVE",
 "DROPPED",
@@ -121619,6 +123232,18 @@ false
 },
 "type": "object"
 },
+"WorkloadIdentityConfig": {
+"id": "WorkloadIdentityConfig",
+"properties": {
+"identity": {
+"type": "string"
+},
+"identityCertificateEnabled": {
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "XpnHostList": {
 "id": "XpnHostList",
 "properties": {
diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json
index ad53752ebb..08b1f1f7e9 100644
--- a/googleapiclient/discovery_cache/documents/compute.beta.json
+++ b/googleapiclient/discovery_cache/documents/compute.beta.json
@@ -126,7 +126,7 @@
 "acceleratorTypes": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/acceleratorTypes",
 "httpMethod": "GET",
 "id": "compute.acceleratorTypes.aggregatedList",
@@ -302,7 +302,7 @@
 "addresses": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/addresses",
 "httpMethod": "GET",
 "id": "compute.addresses.aggregatedList",
@@ -754,7 +754,7 @@
 "autoscalers": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/autoscalers",
 "httpMethod": "GET",
 "id": "compute.autoscalers.aggregatedList",
@@ -1817,7 +1817,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/backendServices",
 "httpMethod": "GET",
 "id": "compute.backendServices.aggregatedList",
@@ -2816,7 +2816,7 @@
 "diskTypes": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/diskTypes",
 "httpMethod": "GET",
 "id": "compute.diskTypes.aggregatedList",
@@ -3042,7 +3042,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/disks",
 "httpMethod": "GET",
 "id": "compute.disks.aggregatedList",
@@ -4605,6 +4605,11 @@
 "httpMethod": "GET",
 "id": "compute.firewallPolicies.listAssociations",
 "parameters": {
+"includeInheritedPolicies": {
+"description": "If set to \"true\", the response will contain a list of all associations for\nthe containing folders and the containing organization of the target. The\nparameter has no effect if the target is an organization.",
+"location": "query",
+"type": "boolean"
+},
 "targetResource": {
 "description": "The target resource to list associations. It is an organization, or a\nfolder.",
 "location": "query",
@@ -5234,7 +5239,7 @@
 "forwardingRules": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/forwardingRules",
 "httpMethod": "GET",
 "id": "compute.forwardingRules.aggregatedList",
@@ -5695,7 +5700,7 @@
 "futureReservations": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, recommendation is that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/futureReservations",
 "httpMethod": "GET",
 "id": "compute.futureReservations.aggregatedList",
@@ -7518,13 +7523,13 @@
 }
 }
 },
-"healthChecks": {
+"globalVmExtensionPolicies": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves the list of all HealthCheck resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
-"flatPath": "projects/{project}/aggregated/healthChecks",
+"description": "Retrieves the list of all VM Extension Policy resources\navailable to the specified project.\n\nTo prevent failure, it's recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
+"flatPath": "projects/{project}/aggregated/vmExtensionPolicies",
 "httpMethod": "GET",
-"id": "compute.healthChecks.aggregatedList",
+"id": "compute.globalVmExtensionPolicies.aggregatedList",
 "parameterOrder": [
 "project"
 ],
@@ -7576,9 +7581,9 @@
 "type": "string"
 }
 },
-"path": "projects/{project}/aggregated/healthChecks",
+"path": "projects/{project}/aggregated/vmExtensionPolicies",
 "response": {
-"$ref": "HealthChecksAggregatedList"
+"$ref": "VmExtensionPolicyAggregatedListResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
@@ -7586,57 +7591,18 @@
 "https://www.googleapis.com/auth/compute.readonly"
 ]
 },
-"delete": {
-"description": "Deletes the specified HealthCheck resource.",
-"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
-"httpMethod": "DELETE",
-"id": "compute.healthChecks.delete",
-"parameterOrder": [
-"project",
-"healthCheck"
-],
-"parameters": {
-"healthCheck": {
-"description": "Name of the HealthCheck resource to delete.",
-"location": "path",
-"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
-"required": true,
-"type": "string"
-},
-"project": {
-"description": "Project ID for this request.",
-"location": "path",
-"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
-"required": true,
-"type": "string"
-},
-"requestId": {
-"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
-"location": "query",
-"type": "string"
-}
-},
-"path": "projects/{project}/global/healthChecks/{healthCheck}",
-"response": {
-"$ref": "Operation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/compute"
-]
-},
 "get": {
-"description": "Returns the specified HealthCheck resource.",
-"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
+"description": "Gets details of a global VM extension policy.",
+"flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
 "httpMethod": "GET",
-"id": "compute.healthChecks.get",
+"id": "compute.globalVmExtensionPolicies.get",
 "parameterOrder": [
 "project",
-"healthCheck"
+"globalVmExtensionPolicy"
 ],
 "parameters": {
-"healthCheck": {
-"description": "Name of the HealthCheck resource to return.",
+"globalVmExtensionPolicy": {
+"description": "Name of the GlobalVmExtensionPolicy resource to return.",
 "location": "path",
 "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
 "required": true,
@@ -7650,55 +7616,25 @@
 "type": "string"
 }
 },
-"path": "projects/{project}/global/healthChecks/{healthCheck}",
+"path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
 "response": {
-"$ref": "HealthCheck"
+"$ref": "GlobalVmExtensionPolicy"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
 "https://www.googleapis.com/auth/compute",
 "https://www.googleapis.com/auth/compute.readonly"
 ]
-},
-"insert": {
-"description": "Creates a HealthCheck resource in the specified project using the data\nincluded in the request.",
-"flatPath": "projects/{project}/global/healthChecks",
-"httpMethod": "POST",
-"id": "compute.healthChecks.insert",
-"parameterOrder": [
-"project"
-],
-"parameters": {
-"project": {
-"description": "Project ID for this request.",
-"location": "path",
-"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
-"required": true,
-"type": "string"
-},
-"requestId": {
-"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
-"location": "query",
-"type": "string"
+}
 }
 },
-"path": "projects/{project}/global/healthChecks",
-"request": {
-"$ref": "HealthCheck"
-},
-"response": {
-"$ref": "Operation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/compute"
-]
-},
-"list": {
-"description": "Retrieves the list of HealthCheck resources available to the specified\nproject.",
-"flatPath": "projects/{project}/global/healthChecks",
+"healthChecks": {
+"methods": {
+"aggregatedList": {
+"description": "Retrieves the list of all HealthCheck resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"flatPath": "projects/{project}/aggregated/healthChecks",
 "httpMethod": "GET",
-"id": "compute.healthChecks.list",
+"id": "compute.healthChecks.aggregatedList",
 "parameterOrder": [
 "project"
 ],
@@ -7708,6 +7644,11 @@
 "location": "query",
 "type": "string"
 },
+"includeAllScopes": {
+"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
+"location": "query",
+"type": "boolean"
+},
 "maxResults": {
 "default": "500",
 "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
@@ -7727,7 +7668,7 @@
 "type": "string"
 },
 "project": {
-"description": "Project ID for this request.",
+"description": "Name of the project scoping this request.",
 "location": "path",
 "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
 "required": true,
@@ -7737,91 +7678,17 @@
 "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
 "location": "query",
 "type": "boolean"
-}
-},
-"path": "projects/{project}/global/healthChecks",
-"response": {
-"$ref": "HealthCheckList"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/compute",
-"https://www.googleapis.com/auth/compute.readonly"
-]
 },
-"patch": {
-"description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
-"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
-"httpMethod": "PATCH",
-"id": "compute.healthChecks.patch",
-"parameterOrder": [
-"project",
-"healthCheck"
-],
-"parameters": {
-"healthCheck": {
-"description": "Name of the HealthCheck resource to patch.",
-"location": "path",
-"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
-"required": true,
-"type": "string"
-},
-"project": {
-"description": "Project ID for this request.",
-"location": "path",
-"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
-"required": true,
-"type": "string"
-},
-"requestId": {
-"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"serviceProjectNumber": {
+"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
+"format": "int64",
 "location": "query",
 "type": "string"
 }
 },
-"path": "projects/{project}/global/healthChecks/{healthCheck}",
-"request": {
-"$ref": "HealthCheck"
-},
-"response": {
-"$ref": "Operation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/compute"
-]
-},
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource.",
-"flatPath": "projects/{project}/global/healthChecks/{resource}/testIamPermissions",
-"httpMethod": "POST",
-"id": "compute.healthChecks.testIamPermissions",
-"parameterOrder": [
-"project",
-"resource"
-],
-"parameters": {
-"project": {
-"description": "Project ID for this request.",
-"location": "path",
-"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
-"required": true,
-"type": "string"
-},
-"resource": {
-"description": "Name or id of the resource for this request.",
-"location": "path",
-"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
-"required": true,
-"type": "string"
-}
-},
-"path": "projects/{project}/global/healthChecks/{resource}/testIamPermissions",
-"request": {
-"$ref": "TestPermissionsRequest"
-},
+"path": "projects/{project}/aggregated/healthChecks",
 "response": {
-"$ref": "TestPermissionsResponse"
+"$ref": "HealthChecksAggregatedList"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
@@ -7829,18 +7696,18 @@
 "https://www.googleapis.com/auth/compute.readonly"
 ]
 },
-"update": {
-"description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request.",
+"delete": {
+"description": "Deletes the specified HealthCheck resource.",
 "flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
-"httpMethod": "PUT",
-"id": "compute.healthChecks.update",
+"httpMethod": "DELETE",
+"id": "compute.healthChecks.delete",
 "parameterOrder": [
 "project",
 "healthCheck"
 ],
 "parameters": {
 "healthCheck": {
-"description": "Name of the HealthCheck resource to update.",
+"description": "Name of the HealthCheck resource to delete.",
 "location": "path",
 "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
 "required": true,
@@ -7860,52 +7727,6 @@
 }
 },
 "path": "projects/{project}/global/healthChecks/{healthCheck}",
-"request": {
-"$ref": "HealthCheck"
-},
-"response": {
-"$ref": "Operation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform",
-"https://www.googleapis.com/auth/compute"
-]
-}
-}
-},
-"httpHealthChecks": {
-"methods": {
-"delete": {
-"description": "Deletes the specified HttpHealthCheck resource.",
-"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
-"httpMethod": "DELETE",
-"id": "compute.httpHealthChecks.delete",
-"parameterOrder": [
-"project",
-"httpHealthCheck"
-],
-"parameters": {
-"httpHealthCheck": {
-"description": "Name of the HttpHealthCheck resource to delete.",
-"location": "path",
-"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
-"required": true,
-"type": "string"
-},
-"project": {
-"description": "Project ID for this request.",
-"location": "path",
-"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
-"required": true,
-"type": "string"
-},
-"requestId": {
-"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
-"location": "query",
-"type": "string"
-}
-},
-"path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
 "response": {
 "$ref": "Operation"
 },
@@ -7915,17 +7736,17 @@
 ]
 },
 "get": {
-"description": "Returns the specified HttpHealthCheck resource.",
-"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+"description": "Returns the specified HealthCheck resource.",
+"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
 "httpMethod": "GET",
-"id": "compute.httpHealthChecks.get",
+"id": "compute.healthChecks.get",
 "parameterOrder": [
 "project",
-"httpHealthCheck"
+"healthCheck"
 ],
 "parameters": {
-"httpHealthCheck": {
-"description": "Name of the HttpHealthCheck resource to return.",
+"healthCheck": {
+"description": "Name of the HealthCheck resource to return.",
 "location": "path",
 "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
 "required": true,
@@ -7939,9 +7760,9 @@
 "type": "string"
 }
 },
-"path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+"path": "projects/{project}/global/healthChecks/{healthCheck}",
 "response": {
-"$ref": "HttpHealthCheck"
+"$ref": "HealthCheck"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform",
@@ -7950,10 +7771,10 @@
 ]
 },
 "insert": {
-"description": "Creates a HttpHealthCheck resource in the specified project using the data\nincluded in the request.",
-"flatPath": "projects/{project}/global/httpHealthChecks",
+"description": "Creates a HealthCheck resource in the specified project using the data\nincluded in the request.",
+"flatPath": "projects/{project}/global/healthChecks",
 "httpMethod": "POST",
-"id": "compute.httpHealthChecks.insert",
+"id": "compute.healthChecks.insert",
 "parameterOrder": [
 "project"
 ],
@@ -7971,9 +7792,9 @@
 "type": "string"
 }
 },
-"path": "projects/{project}/global/httpHealthChecks",
+"path": "projects/{project}/global/healthChecks",
 "request": {
-"$ref": "HttpHealthCheck"
+"$ref": "HealthCheck"
 },
 "response": {
 "$ref": "Operation"
@@ -7984,10 +7805,299 @@
 ]
 },
 "list": {
-"description": "Retrieves the list of HttpHealthCheck resources available to the specified\nproject.",
-"flatPath": "projects/{project}/global/httpHealthChecks",
+"description": "Retrieves the list of HealthCheck resources available to the specified\nproject.",
+"flatPath": "projects/{project}/global/healthChecks",
 "httpMethod": "GET",
-"id": "compute.httpHealthChecks.list",
+"id": "compute.healthChecks.list",
+"parameterOrder": [
+"project"
+],
+"parameters": {
+"filter": {
+"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+"location": "query",
+"type": "string"
+},
+"maxResults": {
+"default": "500",
+"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+"format": "uint32",
+"location": "query",
+"minimum": "0",
+"type": "integer"
+},
+"orderBy": {
+"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+"location": "query",
+"type": "string"
+},
+"pageToken": {
+"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "projects/{project}/global/healthChecks",
+"response": {
+"$ref": "HealthCheckList"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"patch": {
+"description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
+"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
+"httpMethod": "PATCH",
+"id": "compute.healthChecks.patch",
+"parameterOrder": [
+"project",
+"healthCheck"
+],
+"parameters": {
+"healthCheck": {
+"description": "Name of the HealthCheck resource to patch.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/global/healthChecks/{healthCheck}",
+"request": {
+"$ref": "HealthCheck"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource.",
+"flatPath": "projects/{project}/global/healthChecks/{resource}/testIamPermissions",
+"httpMethod": "POST",
+"id": "compute.healthChecks.testIamPermissions",
+"parameterOrder": [
+"project",
+"resource"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"resource": {
+"description": "Name or id of the resource for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/healthChecks/{resource}/testIamPermissions",
+"request": {
+"$ref": "TestPermissionsRequest"
+},
+"response": {
+"$ref": "TestPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"update": {
+"description": "Updates a HealthCheck resource in the specified project using the data\nincluded in the request.",
+"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
+"httpMethod": "PUT",
+"id": "compute.healthChecks.update",
+"parameterOrder": [
+"project",
+"healthCheck"
+],
+"parameters": {
+"healthCheck": {
+"description": "Name of the HealthCheck resource to update.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/global/healthChecks/{healthCheck}",
+"request": {
+"$ref": "HealthCheck"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+}
+}
+},
+"httpHealthChecks": {
+"methods": {
+"delete": {
+"description": "Deletes the specified HttpHealthCheck resource.",
+"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+"httpMethod": "DELETE",
+"id": "compute.httpHealthChecks.delete",
+"parameterOrder": [
+"project",
+"httpHealthCheck"
+],
+"parameters": {
+"httpHealthCheck": {
+"description": "Name of the HttpHealthCheck resource to delete.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"get": {
+"description": "Returns the specified HttpHealthCheck resource.",
+"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+"httpMethod": "GET",
+"id": "compute.httpHealthChecks.get",
+"parameterOrder": [
+"project",
+"httpHealthCheck"
+],
+"parameters": {
+"httpHealthCheck": {
+"description": "Name of the HttpHealthCheck resource to return.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
+"response": {
+"$ref": "HttpHealthCheck"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"insert": {
+"description": "Creates a HttpHealthCheck resource in the specified project using the data\nincluded in the request.",
+"flatPath": "projects/{project}/global/httpHealthChecks",
+"httpMethod": "POST",
+"id": "compute.httpHealthChecks.insert",
+"parameterOrder": [
+"project"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/global/httpHealthChecks",
+"request": {
+"$ref": "HttpHealthCheck"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"list": {
+"description": "Retrieves the list of HttpHealthCheck resources available to the specified\nproject.",
+"flatPath": "projects/{project}/global/httpHealthChecks",
+"httpMethod": "GET",
+"id": "compute.httpHealthChecks.list",
 "parameterOrder": [
 "project"
 ],
@@ -9605,6 +9715,47 @@
 "https://www.googleapis.com/auth/compute.readonly"
 ]
 },
+"getAvailableAcceleratorTopologies": {
+"description": "Returns information about available accelerator topologies for a given MIG.",
+"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies",
+"httpMethod": "GET",
+"id": "compute.instanceGroupManagers.getAvailableAcceleratorTopologies",
+"parameterOrder": [
+"project",
+"zone",
+"resourceId"
+],
+"parameters": {
+"project": {
+"description": "Required. Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"resourceId": {
+"description": "Required. The name of the managed instance group.\nIt should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"zone": {
+"description": "Required. The name of thezone where the managed\ninstance group is located.\nName should conform to RFC1035.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{resourceId}/getAvailableAcceleratorTopologies",
+"response": {
+"$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
 "insert": {
 "description": "Creates a managed instance group using the information that you specify\nin the request. After the group is created, instances in the group are\ncreated using the specified instance template.\nThis operation is marked as DONE when the group is created\neven if the instances in the group have not yet been created. You\nmust separately verify the status of the individual instances with thelistmanagedinstances\nmethod.\n\nA managed instance group can have up to 1000 VM instances per group. Please\ncontact Cloud Support if you need an increase in\nthis limit.",
 "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers",
@@ -19008,7 +19159,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/firewallPolicies",
 "httpMethod": "GET",
 "id": "compute.networkFirewallPolicies.aggregatedList",
@@ -23203,7 +23354,7 @@
 },
 "moveDisk": {
 "deprecated": true,
-"description": "Starting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
+"description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
 "flatPath": "projects/{project}/moveDisk",
 "httpMethod": "POST",
 "id": "compute.projects.moveDisk",
@@ -25532,7 +25683,7 @@
 "regionCommitments": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/commitments",
 "httpMethod": "GET",
 "id": "compute.regionCommitments.aggregatedList",
@@ -25907,7 +26058,7 @@
 "regionCompositeHealthChecks": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/compositeHealthChecks",
 "httpMethod": "GET",
 "id": "compute.regionCompositeHealthChecks.aggregatedList",
@@ -27300,7 +27451,7 @@
 "regionHealthAggregationPolicies": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/healthAggregationPolicies",
 "httpMethod": "GET",
 "id": "compute.regionHealthAggregationPolicies.aggregatedList",
@@ -37314,6 +37465,21 @@
 "required": true,
 "type": "string"
 },
+"view": {
+"description": "View of the subBlock.",
+"enum": [
+"SUB_BLOCK_VIEW_BASIC",
+"SUB_BLOCK_VIEW_FULL",
+"SUB_BLOCK_VIEW_UNSPECIFIED"
+],
+"enumDescriptions": [
+"This view includes basic information about the reservation sub block",
+"Includes detailed topology view.",
+"The default / unset value. The API will default to the BASIC view."
+],
+"location": "query",
+"type": "string"
+},
 "zone": {
 "description": "Name of the zone for this request. Zone name should conform to RFC1035.",
 "location": "path",
@@ -37673,7 +37839,7 @@
 "reservations": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/reservations",
 "httpMethod": "GET",
 "id": "compute.reservations.aggregatedList",
@@ -42820,6 +42986,20 @@
 "format": "int64",
 "location": "query",
 "type": "string"
+},
+"views": {
+"description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n   \n   - WITH_UTILIZATION: Utilization data is included in the\n   response.",
+"enum": [
+"DEFAULT",
+"WITH_UTILIZATION"
+],
+"enumDescriptions": [
+"",
+"Utilization data is included in the response."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
 }
 },
 "path": "projects/{project}/aggregated/subnetworks",
@@ -48329,6 +48509,253 @@
 }
 }
 },
+"zoneVmExtensionPolicies": {
+"methods": {
+"delete": {
+"description": "Deletes a specified zone VM extension policy.",
+"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
+"httpMethod": "DELETE",
+"id": "compute.zoneVmExtensionPolicies.delete",
+"parameterOrder": [
+"project",
+"zone",
+"vmExtensionPolicy"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"vmExtensionPolicy": {
+"description": "Name of the zone VM extension policy to delete.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"zone": {
+"description": "Name of the zone for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"get": {
+"description": "Retrieves details of a specific zone VM extension policy.",
+"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
+"httpMethod": "GET",
+"id": "compute.zoneVmExtensionPolicies.get",
+"parameterOrder": [
+"project",
+"zone",
+"vmExtensionPolicy"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"vmExtensionPolicy": {
+"description": "Name of the VM extension policy resource to return.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"zone": {
+"description": "Name of the zone for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
+"response": {
+"$ref": "VmExtensionPolicy"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"insert": {
+"description": "Creates a new zone-level VM extension policy within a project.",
+"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies",
+"httpMethod": "POST",
+"id": "compute.zoneVmExtensionPolicies.insert",
+"parameterOrder": [
+"project",
+"zone"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"zone": {
+"description": "Name of the zone for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/vmExtensionPolicies",
+"request": {
+"$ref": "VmExtensionPolicy"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
+"list": {
+"description": "Lists all VM extension policies within a specific zone for a project.",
+"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies",
+"httpMethod": "GET",
+"id": "compute.zoneVmExtensionPolicies.list",
+"parameterOrder": [
+"project",
+"zone"
+],
+"parameters": {
+"filter": {
+"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+"location": "query",
+"type": "string"
+},
+"maxResults": {
+"default": "500",
+"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+"format": "uint32",
+"location": "query",
+"minimum": "0",
+"type": "integer"
+},
+"orderBy": {
+"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+"location": "query",
+"type": "string"
+},
+"pageToken": {
+"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+"location": "query",
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"returnPartialSuccess": {
+"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+"location": "query",
+"type": "boolean"
+},
+"zone": {
+"description": "Name of the zone for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/vmExtensionPolicies",
+"response": {
+"$ref": "VmExtensionPolicyList"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
+"update": {
+"description": "Modifies an existing zone VM extension policy.",
+"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
+"httpMethod": "PATCH",
+"id": "compute.zoneVmExtensionPolicies.update",
+"parameterOrder": [
+"project",
+"zone",
+"vmExtensionPolicy"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"vmExtensionPolicy": {
+"description": "Name of the zone VM extension policy to update.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"zone": {
+"description": "Name of the zone for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
+"request": {
+"$ref": "VmExtensionPolicy"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+}
+}
+},
 "zones": {
 "methods": {
 "get": {
@@ -48424,7 +48851,7 @@
 }
 }
 },
-"revision": "20251015",
+"revision": "20251019",
 "rootUrl": "https://compute.googleapis.com/",
 "schemas": {
 "AWSV4Signature": {
@@ -48466,6 +48893,66 @@
 },
 "type": "object"
 },
+"AcceleratorTopologiesInfo": {
+"description": "Info for accelerator topologies within a densely packed reservation.",
+"id": "AcceleratorTopologiesInfo",
+"properties": {
+"acceleratorTopologyInfos": {
+"description": "Info for each accelerator topology.",
+"items": {
+"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AcceleratorTopologiesInfoAcceleratorTopologyInfo": {
+"description": "Info for a slice of a given topology.",
+"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo",
+"properties": {
+"acceleratorTopology": {
+"description": "The accelerator topology.",
+"type": "string"
+},
+"infoPerTopologyStates": {
+"description": "Info for each topology state.",
+"items": {
+"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": {
+"description": "Info for each topology state.",
+"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState",
+"properties": {
+"count": {
+"description": "The number of accelerator topologies in this state.",
+"format": "int32",
+"type": "integer"
+},
+"state": {
+"description": "The state of the accelerator topology.",
+"enum": [
+"AVAILABLE",
+"RUNNING",
+"TOPOLOGY_STATE_UNSPECIFIED",
+"UNHEALTHY"
+],
+"enumDescriptions": [
+"The accelerator topology is available.",
+"The accelerator topology is running.",
+"The state of the topology is unspecified.",
+"The accelerator topology is unhealthy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "AcceleratorType": {
 "description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.",
 "id": "AcceleratorType",
@@ -51364,6 +51851,10 @@ false
 "$ref": "BackendBucketParams",
 "description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
 },
+"region": {
+"description": "[Output Only] URL of the region where the regional backend bucket\nresides. This field is not applicable to global backend buckets.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
+"type": "string"
+},
 "selfLink": {
 "description": "[Output Only] Server-defined URL for the resource.",
 "type": "string"
@@ -51651,7 +52142,7 @@ false
 "id": "BackendBucketCdnPolicyNegativeCachingPolicy",
 "properties": {
 "code": {
-"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
 "format": "int32",
 "type": "integer"
 },
@@ -52147,7 +52638,7 @@ false
 "type": "number"
 },
 "name": {
-"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
+"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
 "type": "string"
 }
 },
@@ -52777,7 +53268,7 @@ false
 "id": "BackendServiceCdnPolicyNegativeCachingPolicy",
 "properties": {
 "code": {
-"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
 "format": "int32",
 "type": "integer"
 },
@@ -52842,7 +53333,7 @@ false
 "type": "boolean"
 },
 "name": {
-"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
+"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
 "type": "string"
 }
 },
@@ -53478,6 +53969,10 @@ false
 "description": "Reference to the BackendAuthenticationConfig resource from the\nnetworksecurity.googleapis.com namespace. Can be used in authenticating\nTLS connections to the backend, as specified by the authenticationMode\nfield. Can only be specified if authenticationMode is not NONE.",
 "type": "string"
 },
+"identity": {
+"description": "Assigns the Managed Identity for the BackendService Workload.\n\n\nUse this property to configure the load balancer back-end to use\ncertificates and roots of trust provisioned by the Managed Workload\nIdentity system. \n\n The `identity` property is the\nfully-specified SPIFFE ID to use in the SVID presented by the Load\nBalancer Workload. \n\n The SPIFFE ID must be a resource starting with the\n`trustDomain` property value, followed by the path to the Managed\nWorkload Identity. \n\n Supported SPIFFE ID format: \n   \n   - ///ns//sa/\n\n\nThe Trust Domain within the Managed Identity must refer to a valid\nWorkload Identity Pool. The TrustConfig and CertificateIssuanceConfig\nwill be inherited from the Workload Identity Pool. \n\n Restrictions: \n   \n   - If you set the `identity` property, you cannot manually set\n   the following fields: \n       - tlsSettings.sni\n      - tlsSettings.subjectAltNames\n      - tlsSettings.authenticationConfig\n   \n\nWhen defining a `identity` for a RegionBackendServices, the\ncorresponding Workload Identity Pool must have a ca_pool\nconfigured in the same region. \n\n The system will set up a read-onlytlsSettings.authenticationConfig for the Managed Identity.",
+"type": "string"
+},
 "sni": {
 "description": "Server Name Indication - see RFC3546 section 3.1. If set, the load\nbalancer sends this string as the SNI hostname in the TLS connection to\nthe backend, and requires that this string match a Subject Alternative\nName (SAN) in the backend's server certificate. With a Regional Internet\nNEG backend, if the SNI is specified here, the load balancer uses it\nregardless of whether the Regional Internet NEG is specified with FQDN or\nIP address and port. When both sni and subjectAltNames[] are specified,\nthe load balancer matches the backend certificate's SAN only to\nsubjectAltNames[].",
 "type": "string"
@@ -55086,6 +55581,13 @@ false
 "description": "[Output Only] Server-defined URL for this resource.",
 "type": "string"
 },
+"unreachables": {
+"description": "[Output Only] Unreachable resources.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "warning": {
 "description": "[Output Only] Informational warning message.",
 "properties": {
@@ -61325,6 +61827,223 @@ false
 },
 "type": "object"
 },
+"GlobalVmExtensionPolicy": {
+"description": "Message describing GlobalVmExtensionPolicy object.",
+"id": "GlobalVmExtensionPolicy",
+"properties": {
+"creationTimestamp": {
+"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
+"type": "string"
+},
+"description": {
+"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
+"type": "string"
+},
+"extensionPolicies": {
+"additionalProperties": {
+"$ref": "GlobalVmExtensionPolicyExtensionPolicy"
+},
+"description": "Required. Map from extension (eg: \"cloudops\") to its policy configuration.\nThe key is the name of the extension.",
+"type": "object"
+},
+"id": {
+"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+"format": "uint64",
+"type": "string"
+},
+"instanceSelectors": {
+"description": "Optional. Selector to target VMs for a policy.\nThere is a logical \"AND\" between instance_selectors.",
+"items": {
+"$ref": "GlobalVmExtensionPolicyInstanceSelector"
+},
+"type": "array"
+},
+"kind": {
+"default": "compute#globalVmExtensionPolicy",
+"description": "[Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.",
+"type": "string"
+},
+"name": {
+"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+},
+"priority": {
+"description": "Optional. Used to resolve conflicts when multiple policies are active for the same\nextension. Defaults to 0.\n\nLarger the number, higher the priority. When the priority is the same,\nthe policy with the newer create time has higher priority.",
+"format": "int32",
+"type": "integer"
+},
+"rolloutOperation": {
+"$ref": "GlobalVmExtensionPolicyRolloutOperation",
+"description": "Required. The rollout strategy and status."
+},
+"scopedResourceStatus": {
+"description": "[Output Only] The scoped resource status. It's only for tracking the\npurging status of the policy.",
+"enum": [
+"SCOPED_RESOURCE_STATUS_DELETING",
+"SCOPED_RESOURCE_STATUS_UNSPECIFIED"
+],
+"enumDescriptions": [
+"The zonal policies are being deleted.",
+"Default value. This value is unused."
+],
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
+"type": "string"
+},
+"selfLinkWithId": {
+"description": "[Output Only] Server-defined URL for this resource's resource id.",
+"type": "string"
+},
+"updateTimestamp": {
+"description": "[Output Only] Update timestamp inRFC3339\ntext format.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyExtensionPolicy": {
+"description": "Policy for a single extension.",
+"id": "GlobalVmExtensionPolicyExtensionPolicy",
+"properties": {
+"pinnedVersion": {
+"description": "Optional. The version pinning for the extension.\nIf empty, the extension will be installed with the latest version\nreleased by the extension producer.",
+"type": "string"
+},
+"stringConfig": {
+"description": "Optional. String configuration. Any string payload that the extension\nunderstands.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyInstanceSelector": {
+"description": "Selector to target VMs for a zone VM extension policy.",
+"id": "GlobalVmExtensionPolicyInstanceSelector",
+"properties": {
+"labelSelector": {
+"$ref": "GlobalVmExtensionPolicyLabelSelector",
+"description": "Optional. Labels within the LabelSelector are OR'd."
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyLabelSelector": {
+"description": "A LabelSelector is applicable for a VM only if it matches all labels in\nthe LabelSelector.",
+"id": "GlobalVmExtensionPolicyLabelSelector",
+"properties": {
+"inclusionLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Labels as key value pairs.\nA VM should contain all the pairs specified in this map to be selected;\nLabels within the LabelSelector are OR'ed.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyRolloutOperation": {
+"description": "Represents the rollout operation",
+"id": "GlobalVmExtensionPolicyRolloutOperation",
+"properties": {
+"rolloutInput": {
+"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput",
+"description": "Required. The rollout input which defines the rollout plan."
+},
+"rolloutStatus": {
+"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus",
+"description": "[Output Only] The rollout status of the policy."
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyRolloutOperationRolloutInput": {
+"id": "GlobalVmExtensionPolicyRolloutOperationRolloutInput",
+"properties": {
+"conflictBehavior": {
+"description": "Optional. [Optional] Specifies the behavior of the Rollout if a conflict is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) empty : don't overwrite the local value if conflict happens. This is\nthe default behavior.\n2) \"overwrite\" : Overwrite the local value with the rollout value.\nThe concept of \"conflict\" applies to:\n1) Insert action. If the zonal policy already exists when Insert\nhappens, it's a conflict.\n2) Update action. If the zonal policy was updated out of band by a\nzonal API, it's a conflict.",
+"type": "string"
+},
+"name": {
+"description": "Optional. The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.",
+"type": "string"
+},
+"predefinedRolloutPlan": {
+"description": "Optional. Predefined rollout plan.",
+"enum": [
+"FAST_ROLLOUT",
+"ROLLOUT_PLAN_UNSPECIFIED",
+"SLOW_ROLLOUT"
+],
+"enumDescriptions": [
+"",
+"",
+""
+],
+"type": "string"
+},
+"retryUuid": {
+"description": "Optional. The UUID of the retry action. Only set it if this is a retry\nfor an existing resource. This is for the user re-populate the resource\nwithout changes. An error will be returned if the retry_uuid is set but\nthe resource get modified.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyRolloutOperationRolloutStatus": {
+"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus",
+"properties": {
+"currentRollouts": {
+"description": "[Output Only] The current rollouts for the latest version of the\nresource. There should be only one current rollout, but for\nscalability, we make it repeated.",
+"items": {
+"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata"
+},
+"type": "array"
+},
+"previousRollout": {
+"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata",
+"description": "[Output Only] The last completed rollout resource. This field will not\nbe populated until the first rollout is completed."
+}
+},
+"type": "object"
+},
+"GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata": {
+"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata",
+"properties": {
+"rollout": {
+"description": "[Output Only] The name of the rollout.\nEx. projects//locations/global/rollouts/.",
+"type": "string"
+},
+"rolloutPlan": {
+"description": "[Output Only] The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.",
+"type": "string"
+},
+"state": {
+"description": "[Output Only] The overall state of the rollout.",
+"enum": [
+"STATE_CANCELLED",
+"STATE_COMPLETED",
+"STATE_FAILED",
+"STATE_PAUSED",
+"STATE_PROCESSING",
+"STATE_UNKNOWN",
+"STATE_UNSPECIFIED"
+],
+"enumDescriptions": [
+"Iteration was explicitly cancelled.",
+"Iteration completed, with all actions being successful.",
+"Iteration completed, with failures.",
+"The rollout is paused.",
+"Iteration is in progress.",
+"Impossible to determine current state of the iteration.",
+"Default value. This value is unused."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GroupMaintenanceInfo": {
 "description": "Maintenance Info for ReservationBlocks.",
 "id": "GroupMaintenanceInfo",
@@ -63110,6 +63829,13 @@ false
 "description": "[Output Only] Server-defined URL for this resource.",
 "type": "string"
 },
+"unreachables": {
+"description": "[Output Only] Unreachable resources.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "warning": {
 "description": "[Output Only] Informational warning message.",
 "properties": {
@@ -66458,7 +67184,7 @@ false
 "id": "InstanceGroupManagerInstanceLifecyclePolicyOnRepair",
 "properties": {
 "allowChangingZone": {
-"description": "Specifies whether the MIG can change a VM's zone during a repair.",
+"description": "Specifies whether the MIG can change a VM's zone during a repair.\nValid values are:\n   \n   - NO (default): MIG cannot change a VM's zone during a\n   repair.\n   - YES: MIG can select a different zone for the VM during\n   a repair.",
 "enum": [
 "NO",
 "YES"
@@ -67439,6 +68165,42 @@ false
 },
 "type": "object"
 },
+"InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse": {
+"id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponse",
+"properties": {
+"acceleratorTopologiesInfo": {
+"additionalProperties": {
+"$ref": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo"
+},
+"description": "The accelerator topology information returned per id of the topology\nlocation.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo": {
+"id": "InstanceGroupManagersGetAvailableAcceleratorTopologiesResponseAcceleratorTopologyInfo",
+"properties": {
+"acceleratorTopology": {
+"description": "Topology in the format of: \"16x16\", \"4x4x4\", etc.",
+"type": "string"
+},
+"acceleratorTopologyHealth": {
+"enum": [
+"DEGRADED",
+"HEALTHY",
+"UNHEALTHY"
+],
+"enumDescriptions": [
+"All VM are in RUNNING state, but there is an issue with\nthe inter-chip connectivity that makes this part\nof the infrastructure ready to use as a working\ninter-chip connected group only in a degraded mode.\nThis is allowed only for Instances configured with ICI\nresiliency",
+"All VM are in RUNNING state, there are no issues with the\ninter-chip connectivity.",
+"Some VMs may not be in RUNNING state, or there is an\nissue with the inter-chip connectivity that makes this\npart of the infrastructure unsuitable for forming a\nworking inter-chip connected group."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "InstanceGroupManagersListErrorsResponse": {
 "id": "InstanceGroupManagersListErrorsResponse",
 "properties": {
@@ -70550,10 +71312,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -70718,10 +71482,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -71019,6 +71785,10 @@ false
 "description": "[Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.",
 "type": "string"
 },
+"l2Forwarding": {
+"$ref": "InterconnectAttachmentL2Forwarding",
+"description": "L2 Interconnect Attachment related config. This field is required if the\ntype is L2_DEDICATED.\n\nThe configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)\nwithin L2 packets are mapped to the destination appliances IP addresses.\nThe packet is then encapsulated with the appliance IP address and sent to\nthe edge appliance."
+},
 "labelFingerprint": {
 "description": "A fingerprint for the labels being applied to this InterconnectAttachment,\nwhich is essentially a hash of the labels set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an InterconnectAttachment.",
 "format": "byte",
@@ -71134,14 +71904,16 @@ false
 "type": "integer"
 },
 "type": {
-"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.",
+"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.",
 "enum": [
 "DEDICATED",
+"L2_DEDICATED",
 "PARTNER",
 "PARTNER_PROVIDER"
 ],
 "enumDescriptions": [
 "Attachment to a dedicated interconnect.",
+"Attachment to a dedicated interconnect, forwarding L2 packets.",
 "Attachment to a partner interconnect, created by the customer.",
 "Attachment to a partner interconnect, created by the partner."
 ],
@@ -71913,6 +72685,88 @@ false
 },
 "type": "object"
 },
+"InterconnectAttachmentL2Forwarding": {
+"description": "L2 Interconnect Attachment related configuration.",
+"id": "InterconnectAttachmentL2Forwarding",
+"properties": {
+"applianceMappings": {
+"additionalProperties": {
+"$ref": "InterconnectAttachmentL2ForwardingApplianceMapping"
+},
+"description": "Optional. A map of VLAN tags to appliances and optional inner mapping\nrules. If VLANs are not explicitly mapped to any appliance, the\ndefaultApplianceIpAddress is used.\n\nEach VLAN tag can be a single number or a range of numbers in the range\nof 1 to 4094, e.g., \"1\" or \"4001-4094\". Non-empty and non-overlapping\nVLAN tag ranges are enforced, and violating operations will be rejected.\n\nThe VLAN tags in the Ethernet header must use an ethertype value of\n0x88A8 or 0x8100.",
+"type": "object"
+},
+"defaultApplianceIpAddress": {
+"description": "Optional. A single IPv4 or IPv6 address used as the default destination\nIP when there is no VLAN mapping result found.\n\nUnset field (null-value) indicates the unmatched packet should be\ndropped.",
+"type": "string"
+},
+"geneveHeader": {
+"$ref": "InterconnectAttachmentL2ForwardingGeneveHeader",
+"description": "Optional. It represents the structure of a Geneve (Generic Network\nVirtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various\nprotocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization\nenvironments."
+},
+"network": {
+"description": "Required. Resource URL of the network to which this attachment belongs.",
+"type": "string"
+},
+"tunnelEndpointIpAddress": {
+"description": "Required. A single IPv4 or IPv6 address. This address will be used as the\nsource IP address for packets sent to the appliances, and must be used as\nthe destination IP address for packets that should be sent out through\nthis attachment.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingApplianceMapping": {
+"description": "Two-level VLAN-to-Appliance mapping rule.",
+"id": "InterconnectAttachmentL2ForwardingApplianceMapping",
+"properties": {
+"applianceIpAddress": {
+"description": "Optional. A single IPv4 or IPv6 address used as the destination IP\naddress for ingress packets that match on a VLAN tag, but do not match\na more specific inner VLAN tag.\n\nUnset field (null-value) indicates both VLAN tags are required to be\nmapped. Otherwise, defaultApplianceIpAddress is used.",
+"type": "string"
+},
+"innerVlanToApplianceMappings": {
+"description": "Optional. Used to match against the inner VLAN when the packet\ncontains two VLAN tags.\n\nA list of mapping rules from inner VLAN tags to IP addresses. If the\ninner VLAN is not explicitly mapped to an IP address range, the\napplianceIpAddress is used.",
+"items": {
+"$ref": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping"
+},
+"type": "array"
+},
+"name": {
+"description": "Optional. The name of this appliance mapping rule.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping": {
+"description": "The inner VLAN-to-Appliance mapping.",
+"id": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping",
+"properties": {
+"innerApplianceIpAddress": {
+"description": "Required in this object. A single IPv4 or IPv6 address used as the\ndestination IP address for ingress packets that match on both VLAN\ntags.",
+"type": "string"
+},
+"innerVlanTags": {
+"description": "Required in this object. Used to match the inner VLAN tag on the\npacket. Each entry can be a single number or a range of numbers in\nthe range of 1 to 4094, e.g., [\"1\", \"4001-4094\"] is valid. Non-empty\nand Non-overlapping VLAN tag ranges are enforced, and violating\noperations will be rejected.\n\nThe inner VLAN tags must have an ethertype value of 0x8100.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingGeneveHeader": {
+"description": "GeneveHeader related configurations.",
+"id": "InterconnectAttachmentL2ForwardingGeneveHeader",
+"properties": {
+"vni": {
+"description": "Optional. VNI is a 24-bit unique virtual network identifier, from 0 to\n16,777,215.",
+"format": "uint32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "InterconnectAttachmentList": {
 "description": "Response to the list request, and contains a list of interconnect\nattachments.",
 "id": "InterconnectAttachmentList",
@@ -72467,7 +73321,7 @@ false
 "type": "string"
 },
 "etag": {
-"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAPI 154.",
+"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.",
 "type": "string"
 },
 "id": {
@@ -72803,10 +73657,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -73252,10 +74108,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -73564,6 +74422,10 @@ false
 "format": "int64",
 "type": "string"
 },
+"l2ForwardingEnabled": {
+"description": "Identifies whether L2 Interconnect Attachments can be created in this\nregion for interconnects that are in this location.",
+"type": "boolean"
+},
 "locationPresence": {
 "description": "Identifies the network presence of this location.",
 "enum": [
@@ -79861,6 +80723,18 @@ false
 ],
 "type": "string"
 },
+"allowMulticast": {
+"description": "Specifies whether multicast is allowed.",
+"enum": [
+"MULTICAST_ALLOWED",
+"MULTICAST_BLOCKED"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "allowNcc": {
 "description": "Specifies whether NCC is allowed.",
 "enum": [
@@ -80018,6 +80892,18 @@ false
 },
 "type": "array"
 },
+"multicast": {
+"description": "Specifies which type of multicast is supported.",
+"enum": [
+"MULTICAST_SDN",
+"MULTICAST_ULL"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "subnetPurposes": {
 "description": "Specifies which subnetwork purposes are supported.",
 "items": {
@@ -89469,6 +90355,10 @@ false
 "description": "Represents a reservation subBlock resource.",
 "id": "ReservationSubBlock",
 "properties": {
+"acceleratorTopologiesInfo": {
+"$ref": "AcceleratorTopologiesInfo",
+"description": "[Output Only] Slice info for the reservation subBlock."
+},
 "count": {
 "description": "[Output Only] The number of hosts that are allocated in this\nreservation subBlock.",
 "format": "int32",
@@ -89817,12 +90707,14 @@ false
 "FAULT_BEHAVIOR_UNSPECIFIED",
 "GPU_ERROR",
 "PERFORMANCE",
+"SILENT_DATA_CORRUPTION",
 "SWITCH_FAILURE"
 ],
 "enumDescriptions": [
 "",
 "The subBlock experienced a GPU error.",
 "The subBlock experienced performance issues.",
+"The subBlock experienced silent data corruption.",
 "The subBlock experienced a switch failure."
 ],
 "type": "string"
@@ -90486,6 +91378,18 @@ false
 "description": "A GroupPlacementPolicy specifies resource placement configuration.\nIt specifies the failure bucket separation",
 "id": "ResourcePolicyGroupPlacementPolicy",
 "properties": {
+"acceleratorTopologyMode": {
+"description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.",
+"enum": [
+"AUTO_CONNECT",
+"PROVISION_ONLY"
+],
+"enumDescriptions": [
+"The interconnected chips are pre-configured at the time of VM creation.",
+"The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected."
+],
+"type": "string"
+},
 "availabilityDomainCount": {
 "description": "The number of availability domains to spread instances across. If two\ninstances are in different availability domain, they are not in the same\nlow latency network.",
 "format": "int32",
@@ -91274,7 +92178,7 @@ false
 "type": "integer"
 },
 "routeStatus": {
-"description": "[Output only] The status of the route.",
+"description": "[Output only] The status of the route. This status only applies to\ndynamic routes learned by Cloud Routers. This status is not applicable\nto static routes.",
 "enum": [
 "ACTIVE",
 "DROPPED",
@@ -96400,6 +97304,14 @@ false
 "description": "A Shielded Instance Identity.",
 "id": "ShieldedInstanceIdentity",
 "properties": {
+"eccP256EncryptionKey": {
+"$ref": "ShieldedInstanceIdentityEntry",
+"description": "An Endorsement Key (EK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM."
+},
+"eccP256SigningKey": {
+"$ref": "ShieldedInstanceIdentityEntry",
+"description": "An Attestation Key (AK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM."
+},
 "encryptionKey": {
 "$ref": "ShieldedInstanceIdentityEntry",
 "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm\nissued to the Shielded Instance's vTPM."
@@ -105357,6 +106269,7 @@ false
 "FAILURE_NETWORK",
 "FAILURE_NVLINK",
 "FAILURE_REDUNDANT_HARDWARE_FAULT",
+"FAILURE_TPU",
 "INFRASTRUCTURE_RELOCATION",
 "MAINTENANCE_REASON_UNKNOWN",
 "PLANNED_NETWORK_UPDATE",
@@ -105375,6 +106288,7 @@ false
 "Maintenance due to network errors.",
 "Maintenance due to NVLink failure.",
 "Maintenance due to redundant hardware fault.",
+"Maintenance due to TPU errors.",
 "Maintenance due to infrastructure relocation.",
 "Unknown maintenance reason. Do not use this value.",
 "Maintenance due to planned network update.",
@@ -106654,6 +107568,602 @@ false
 },
 "type": "object"
 },
+"VmExtensionPoliciesScopedList": {
+"id": "VmExtensionPoliciesScopedList",
+"properties": {
+"vmExtensionPolicies": {
+"description": "List of VmExtensionPolicy resources contained in this scope.",
+"items": {
+"$ref": "VmExtensionPolicy"
+},
+"type": "array"
+},
+"warning": {
+"description": "Informational warning which replaces the list of\nbackend services when the list is empty.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"VmExtensionPolicy": {
+"description": "Represents a VM extension policy.",
+"id": "VmExtensionPolicy",
+"properties": {
+"creationTimestamp": {
+"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
+"type": "string"
+},
+"description": {
+"description": "An optional description of this resource.",
+"type": "string"
+},
+"extensionPolicies": {
+"additionalProperties": {
+"$ref": "VmExtensionPolicyExtensionPolicy"
+},
+"description": "Required. A map of extension names (e.g., \"cloudops\") to their corresponding policy\nconfigurations.",
+"type": "object"
+},
+"globalResourceLink": {
+"description": "Optional. [Output Only] Link to the global policy that manages this zone policy, if\napplicable.",
+"type": "string"
+},
+"id": {
+"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+"format": "uint64",
+"type": "string"
+},
+"instanceSelectors": {
+"description": "Optional. Selectors to target VMs for this policy. VMs are selected if they match\n*any* of the provided selectors (logical OR). If this list is empty, the\npolicy applies to all VMs.",
+"items": {
+"$ref": "VmExtensionPolicyInstanceSelector"
+},
+"type": "array"
+},
+"kind": {
+"default": "compute#vmExtensionPolicy",
+"description": "[Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.",
+"type": "string"
+},
+"managedByGlobal": {
+"description": "Optional. [Output Only] Indicates if this policy is managed by a global policy.",
+"type": "boolean"
+},
+"name": {
+"annotations": {
+"required": [
+"compute.zoneVmExtensionPolicies.insert"
+]
+},
+"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+"type": "string"
+},
+"priority": {
+"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the more recent creation timestamp takes precedence.",
+"format": "int32",
+"type": "integer"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
+"type": "string"
+},
+"selfLinkWithId": {
+"description": "[Output Only] Server-defined URL for this resource's resource id.",
+"type": "string"
+},
+"state": {
+"description": "Optional. [Output Only] Current state of the policy: ACTIVE or DELETING.",
+"enum": [
+"ACTIVE",
+"DELETING",
+"STATE_UNSPECIFIED"
+],
+"enumDescriptions": [
+"The policy is active and applied to matching VMs.\nNewly created VMs that match the policy will also receive the\nextension policy.",
+"The policy is in the process of being deleted. After the extension is\nremoved from all matching VMs, the policy will be deleted.",
+"Default value. Do not use."
+],
+"type": "string"
+},
+"updateTimestamp": {
+"description": "[Output Only] Update timestamp inRFC3339\ntext format.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"VmExtensionPolicyAggregatedListResponse": {
+"description": "Response for the aggregated list of VM extension policies.",
+"id": "VmExtensionPolicyAggregatedListResponse",
+"properties": {
+"etag": {
+"type": "string"
+},
+"id": {
+"description": "[Output Only] Unique identifier for the resource; defined by the server.",
+"type": "string"
+},
+"items": {
+"additionalProperties": {
+"$ref": "VmExtensionPoliciesScopedList",
+"description": "Name of the scope containing this set of VmExtensionPolicies."
+},
+"description": "A list of VmExtensionPoliciesScopedList resources.",
+"type": "object"
+},
+"kind": {
+"default": "compute#VmExtensionPolicyAggregatedList",
+"description": "[Output Only] Type of resource. Alwayscompute#VmExtensionPolicyAggregatedList for lists of\nVmExtensionPolicies.",
+"type": "string"
+},
+"nextPageToken": {
+"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined URL for this resource.",
+"type": "string"
+},
+"unreachables": {
+"description": "[Output Only] Unreachable resources.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"warning": {
+"description": "[Output Only] Informational warning message.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
+"VmExtensionPolicyExtensionPolicy": {
+"description": "Configuration for a specific VM extension.",
+"id": "VmExtensionPolicyExtensionPolicy",
+"properties": {
+"pinnedVersion": {
+"description": "Optional. The specific version of the extension to install. If not set, the latest\nversion is used.",
+"type": "string"
+},
+"stringConfig": {
+"description": "Optional. String-based configuration data for the extension.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"VmExtensionPolicyInstanceSelector": {
+"description": "Defines how to select VMs to apply a zone VM extension policy.",
+"id": "VmExtensionPolicyInstanceSelector",
+"properties": {
+"labelSelector": {
+"$ref": "VmExtensionPolicyLabelSelector",
+"description": "Optional. LabelSelector selects VMs based on their labels."
+}
+},
+"type": "object"
+},
+"VmExtensionPolicyLabelSelector": {
+"description": "A LabelSelector is applied to a VM only if it matches all the specified\nlabels.",
+"id": "VmExtensionPolicyLabelSelector",
+"properties": {
+"inclusionLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. A map of key-value pairs representing VM labels.\nVMs must have all of the labels specified in this map to be selected\n(logical AND).\n\ne.g. If the `inclusion_labels` are {(\"key1\", \"value1\"), (\"key2\",\n\"value2\")}, the VM labels must contain both (\"key1\", \"value1\") and\n(\"key2\", \"value2\") to be selected. If the VM labels are (\"key1\",\n\"value1\") and (\"something\", \"else\"), it will not be selected.\n\nIf the map is empty, it's considered a match.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"VmExtensionPolicyList": {
+"id": "VmExtensionPolicyList",
+"properties": {
+"etag": {
+"description": "[Output Only] Fingerprint of this resource. A hash of the contents stored\nin this object. This field is used in optimistic locking. This field will\nbe ignored when inserting a VmExtensionPolicy. An up-to-date\nfingerprint must be provided in order to update the VmExtensionPolicy.\n\nTo see the latest value of the fingerprint, make a get() request to\nretrieve a VmExtensionPolicy.",
+"type": "string"
+},
+"id": {
+"description": "[Output Only] Unique identifier for the resource; defined by the server.",
+"type": "string"
+},
+"items": {
+"description": "[Output Only] A list of VM extension policy resources.",
+"items": {
+"$ref": "VmExtensionPolicy"
+},
+"type": "array"
+},
+"kind": {
+"default": "compute#vmExtensionPolicyList",
+"description": "Type of resource.",
+"type": "string"
+},
+"nextPageToken": {
+"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+"type": "string"
+},
+"selfLink": {
+"description": "[Output Only] Server-defined URL for this resource.",
+"type": "string"
+},
+"unreachables": {
+"description": "[Output Only] Unreachable resources.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"warning": {
+"description": "[Output Only] Informational warning message.",
+"properties": {
+"code": {
+"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+"enum": [
+"CLEANUP_FAILED",
+"DEPRECATED_RESOURCE_USED",
+"DEPRECATED_TYPE_USED",
+"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+"EXPERIMENTAL_TYPE_USED",
+"EXTERNAL_API_WARNING",
+"FIELD_VALUE_OVERRIDEN",
+"INJECTED_KERNELS_DEPRECATED",
+"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+"LARGE_DEPLOYMENT_WARNING",
+"LIST_OVERHEAD_QUOTA_EXCEED",
+"MISSING_TYPE_DEPENDENCY",
+"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+"NEXT_HOP_CANNOT_IP_FORWARD",
+"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+"NEXT_HOP_INSTANCE_NOT_FOUND",
+"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+"NEXT_HOP_NOT_RUNNING",
+"NOT_CRITICAL_ERROR",
+"NO_RESULTS_ON_PAGE",
+"PARTIAL_SUCCESS",
+"QUOTA_INFO_UNAVAILABLE",
+"REQUIRED_TOS_AGREEMENT",
+"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+"RESOURCE_NOT_DELETED",
+"SCHEMA_VALIDATION_IGNORED",
+"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+"UNDECLARED_PROPERTIES",
+"UNREACHABLE"
+],
+"enumDeprecated": [
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"Warning about failed cleanup of transient changes made by a failed\noperation.",
+"A link to a deprecated resource was created.",
+"When deploying and at least one of the resources has a type marked as\ndeprecated",
+"The user created a boot disk that is larger than image size.",
+"When deploying and at least one of the resources has a type marked as\nexperimental",
+"Warning that is present in an external api call",
+"Warning that value of a field has been overridden.\nDeprecated unused field.",
+"The operation involved use of an injected kernel, which is deprecated.",
+"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+"When deploying a deployment with a exceedingly large number of resources",
+"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+"A resource depends on a missing type",
+"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+"The route's next hop instance cannot ip forward.",
+"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+"The route's nextHopInstance URL refers to an instance that does not exist.",
+"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+"The route's next hop instance does not have a status of RUNNING.",
+"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+"No results are present on a particular list page.",
+"Success is reported, but some results may be missing due to errors",
+"Quota information is not available to client requests (e.g:\nregions.list).",
+"The user attempted to use a resource that requires a TOS they have not\naccepted.",
+"Warning that a resource is in use.",
+"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+"When a resource schema validation is ignored.",
+"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+"When undeclared properties in the schema are present",
+"A given scope cannot be reached."
+],
+"type": "string"
+},
+"data": {
+"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
+"items": {
+"properties": {
+"key": {
+"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+"type": "string"
+},
+"value": {
+"description": "[Output Only] A warning data value corresponding to the key.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "[Output Only] A human-readable description of the warning code.",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"type": "object"
+},
 "VpnGateway": {
 "description": "Represents a HA VPN gateway.\n\nHA VPN is a high-availability (HA) Cloud VPN solution that lets you securely\nconnect your on-premises network to your Google Cloud Virtual Private Cloud\nnetwork through an IPsec VPN connection in a single region.\nFor more information about Cloud HA VPN solutions, see\nCloud VPN topologies .",
 "id": "VpnGateway",
diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json
index f3b4edc504..e95b0d9f1d 100644
--- a/googleapiclient/discovery_cache/documents/compute.v1.json
+++ b/googleapiclient/discovery_cache/documents/compute.v1.json
@@ -126,7 +126,7 @@
 "acceleratorTypes": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/acceleratorTypes",
 "httpMethod": "GET",
 "id": "compute.acceleratorTypes.aggregatedList",
@@ -302,7 +302,7 @@
 "addresses": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of addresses.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/addresses",
 "httpMethod": "GET",
 "id": "compute.addresses.aggregatedList",
@@ -713,7 +713,7 @@
 "autoscalers": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/autoscalers",
 "httpMethod": "GET",
 "id": "compute.autoscalers.aggregatedList",
@@ -1609,7 +1609,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves the list of all BackendService resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/backendServices",
 "httpMethod": "GET",
 "id": "compute.backendServices.aggregatedList",
@@ -2518,7 +2518,7 @@
 "diskTypes": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/diskTypes",
 "httpMethod": "GET",
 "id": "compute.diskTypes.aggregatedList",
@@ -2744,7 +2744,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of persistent disks.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/disks",
 "httpMethod": "GET",
 "id": "compute.disks.aggregatedList",
@@ -4707,6 +4707,44 @@
 "https://www.googleapis.com/auth/compute"
 ]
 },
+"testIamPermissions": {
+"description": "Returns permissions that a caller has on the specified resource.",
+"flatPath": "projects/{project}/global/firewalls/{resource}/testIamPermissions",
+"httpMethod": "POST",
+"id": "compute.firewalls.testIamPermissions",
+"parameterOrder": [
+"project",
+"resource"
+],
+"parameters": {
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"resource": {
+"description": "Name or id of the resource for this request.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+}
+},
+"path": "projects/{project}/global/firewalls/{resource}/testIamPermissions",
+"request": {
+"$ref": "TestPermissionsRequest"
+},
+"response": {
+"$ref": "TestPermissionsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute",
+"https://www.googleapis.com/auth/compute.readonly"
+]
+},
 "update": {
 "description": "Updates the specified firewall rule with the data included in the\nrequest.\nNote that all fields will be updated if using PUT, even fields that are not\nspecified. To update individual fields, please use PATCH instead.",
 "flatPath": "projects/{project}/global/firewalls/{firewall}",
@@ -4754,7 +4792,7 @@
 "forwardingRules": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of forwarding rules.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/forwardingRules",
 "httpMethod": "GET",
 "id": "compute.forwardingRules.aggregatedList",
@@ -5169,7 +5207,7 @@
 "futureReservations": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, recommendation is that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/futureReservations",
 "httpMethod": "GET",
 "id": "compute.futureReservations.aggregatedList",
@@ -17735,7 +17773,7 @@
 ]
 },
 "aggregatedList": {
-"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/firewallPolicies",
 "httpMethod": "GET",
 "id": "compute.networkFirewallPolicies.aggregatedList",
@@ -21880,7 +21918,7 @@
 },
 "moveDisk": {
 "deprecated": true,
-"description": "Starting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
+"description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
 "flatPath": "projects/{project}/moveDisk",
 "httpMethod": "POST",
 "id": "compute.projects.moveDisk",
@@ -23672,7 +23710,7 @@
 "regionCommitments": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of commitments by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/commitments",
 "httpMethod": "GET",
 "id": "compute.regionCommitments.aggregatedList",
@@ -31830,6 +31868,21 @@
 "required": true,
 "type": "string"
 },
+"view": {
+"description": "View of the subBlock.",
+"enum": [
+"SUB_BLOCK_VIEW_BASIC",
+"SUB_BLOCK_VIEW_FULL",
+"SUB_BLOCK_VIEW_UNSPECIFIED"
+],
+"enumDescriptions": [
+"This view includes basic information about the reservation sub block",
+"Includes detailed topology view.",
+"The default / unset value. The API will default to the BASIC view."
+],
+"location": "query",
+"type": "string"
+},
 "zone": {
 "description": "Name of the zone for this request. Zone name should conform to RFC1035.",
 "location": "path",
@@ -32189,7 +32242,7 @@
 "reservations": {
 "methods": {
 "aggregatedList": {
-"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
+"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
 "flatPath": "projects/{project}/aggregated/reservations",
 "httpMethod": "GET",
 "id": "compute.reservations.aggregatedList",
@@ -37072,6 +37125,20 @@
 "format": "int64",
 "location": "query",
 "type": "string"
+},
+"views": {
+"description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n   \n   - WITH_UTILIZATION: Utilization data is included in the\n   response.",
+"enum": [
+"DEFAULT",
+"WITH_UTILIZATION"
+],
+"enumDescriptions": [
+"",
+"Utilization data is included in the response."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
 }
 },
 "path": "projects/{project}/aggregated/subnetworks",
@@ -42356,7 +42423,7 @@
 }
 }
 },
-"revision": "20251015",
+"revision": "20251019",
 "rootUrl": "https://compute.googleapis.com/",
 "schemas": {
 "AWSV4Signature": {
@@ -42398,6 +42465,66 @@
 },
 "type": "object"
 },
+"AcceleratorTopologiesInfo": {
+"description": "Info for accelerator topologies within a densely packed reservation.",
+"id": "AcceleratorTopologiesInfo",
+"properties": {
+"acceleratorTopologyInfos": {
+"description": "Info for each accelerator topology.",
+"items": {
+"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AcceleratorTopologiesInfoAcceleratorTopologyInfo": {
+"description": "Info for a slice of a given topology.",
+"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo",
+"properties": {
+"acceleratorTopology": {
+"description": "The accelerator topology.",
+"type": "string"
+},
+"infoPerTopologyStates": {
+"description": "Info for each topology state.",
+"items": {
+"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": {
+"description": "Info for each topology state.",
+"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState",
+"properties": {
+"count": {
+"description": "The number of accelerator topologies in this state.",
+"format": "int32",
+"type": "integer"
+},
+"state": {
+"description": "The state of the accelerator topology.",
+"enum": [
+"AVAILABLE",
+"RUNNING",
+"TOPOLOGY_STATE_UNSPECIFIED",
+"UNHEALTHY"
+],
+"enumDescriptions": [
+"The accelerator topology is available.",
+"The accelerator topology is running.",
+"The state of the topology is unspecified.",
+"The accelerator topology is unhealthy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "AcceleratorType": {
 "description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.",
 "id": "AcceleratorType",
@@ -45311,7 +45438,7 @@ false
 "id": "BackendBucketCdnPolicyNegativeCachingPolicy",
 "properties": {
 "code": {
-"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
 "format": "int32",
 "type": "integer"
 },
@@ -45516,7 +45643,7 @@ false
 "type": "number"
 },
 "name": {
-"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
+"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
 "type": "string"
 }
 },
@@ -46138,7 +46265,7 @@ false
 "id": "BackendServiceCdnPolicyNegativeCachingPolicy",
 "properties": {
 "code": {
-"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be\nspecified as values, and you cannot specify a status code more than\nonce.",
+"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
 "format": "int32",
 "type": "integer"
 },
@@ -46203,7 +46330,7 @@ false
 "type": "boolean"
 },
 "name": {
-"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression[a-z]([-_.a-z0-9]*[a-z0-9])? which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
+"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
 "type": "string"
 }
 },
@@ -52621,6 +52748,20 @@ false
 ],
 "type": "string"
 },
+"reservationMode": {
+"description": "The reservation mode which determines reservation-termination behavior and\nexpected pricing.",
+"enum": [
+"CALENDAR",
+"DEFAULT",
+"RESERVATION_MODE_UNSPECIFIED"
+],
+"enumDescriptions": [
+"The delivered reservations will delivered at specified start time and\nterminated at specified end time along with terminating the VMs running\non it.",
+"The delivered reservations do not terminate VMs at the end of\nreservations. This is default mode.",
+""
+],
+"type": "string"
+},
 "reservationName": {
 "description": "Name of reservations where the capacity is provisioned at the time of\ndelivery of  future reservations. If the reservation with the given name\ndoes not exist already, it is created automatically at the time of Approval\nwith INACTIVE state till specified start-time. Either provide the\nreservation_name or a name_prefix.",
 "type": "string"
@@ -53435,6 +53576,35 @@ false
 },
 "type": "object"
 },
+"GRPCTLSHealthCheck": {
+"id": "GRPCTLSHealthCheck",
+"properties": {
+"grpcServiceName": {
+"description": "The gRPC service name for the health check. This field is optional. The\nvalue of grpc_service_name has the following meanings by convention: \n\n- Empty service_name means the overall status of all services at the\nbackend. \n\n- Non-empty service_name means the health of that gRPC service, as defined\nby the owner of the service. \n\nThe grpc_service_name can only be ASCII.",
+"type": "string"
+},
+"port": {
+"description": "The TCP port number to which the health check prober sends packets. Valid\nvalues are 1 through 65535.",
+"format": "int32",
+"type": "integer"
+},
+"portSpecification": {
+"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
+"enum": [
+"USE_FIXED_PORT",
+"USE_NAMED_PORT",
+"USE_SERVING_PORT"
+],
+"enumDescriptions": [
+"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
+"Not supported.",
+"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GlobalAddressesMoveRequest": {
 "id": "GlobalAddressesMoveRequest",
 "properties": {
@@ -53880,6 +54050,9 @@ false
 "grpcHealthCheck": {
 "$ref": "GRPCHealthCheck"
 },
+"grpcTlsHealthCheck": {
+"$ref": "GRPCTLSHealthCheck"
+},
 "healthyThreshold": {
 "description": "A so-far unhealthy instance will be marked healthy after this\nmany consecutive successes. The default value is 2.",
 "format": "int32",
@@ -53943,6 +54116,7 @@ false
 "description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.",
 "enum": [
 "GRPC",
+"GRPC_WITH_TLS",
 "HTTP",
 "HTTP2",
 "HTTPS",
@@ -53957,6 +54131,7 @@ false
 "",
 "",
 "",
+"",
 ""
 ],
 "type": "string"
@@ -61285,10 +61460,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -61431,6 +61608,10 @@ false
 ],
 "type": "string"
 },
+"params": {
+"$ref": "InterconnectParams",
+"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
+},
 "peerIpAddress": {
 "description": "[Output Only] IP address configured on the customer side of the\nInterconnect link. The customer should configure this IP address during\nturnup when prompted by Google NOC. This can be used only for ping tests.",
 "type": "string"
@@ -61449,10 +61630,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -61734,6 +61917,10 @@ false
 "description": "[Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.",
 "type": "string"
 },
+"l2Forwarding": {
+"$ref": "InterconnectAttachmentL2Forwarding",
+"description": "L2 Interconnect Attachment related config. This field is required if the\ntype is L2_DEDICATED.\n\nThe configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)\nwithin L2 packets are mapped to the destination appliances IP addresses.\nThe packet is then encapsulated with the appliance IP address and sent to\nthe edge appliance."
+},
 "labelFingerprint": {
 "description": "A fingerprint for the labels being applied to this InterconnectAttachment,\nwhich is essentially a hash of the labels set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an InterconnectAttachment.",
 "format": "byte",
@@ -61772,6 +61959,10 @@ false
 "description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not\npresent for DEDICATED].\nThe opaque identifier of a PARTNER attachment used to initiate\nprovisioning with a selected partner.\nOf the form \"XXXXX/region/domain\"",
 "type": "string"
 },
+"params": {
+"$ref": "InterconnectAttachmentParams",
+"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
+},
 "partnerAsn": {
 "description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they\nconfigured BGP on behalf of the customer.\nOutput only for PARTNER type, input only for PARTNER_PROVIDER, not\navailable for DEDICATED.",
 "format": "int64",
@@ -61845,14 +62036,16 @@ false
 "type": "integer"
 },
 "type": {
-"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.",
+"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.",
 "enum": [
 "DEDICATED",
+"L2_DEDICATED",
 "PARTNER",
 "PARTNER_PROVIDER"
 ],
 "enumDescriptions": [
 "Attachment to a dedicated interconnect.",
+"Attachment to a dedicated interconnect, forwarding L2 packets.",
 "Attachment to a partner interconnect, created by the customer.",
 "Attachment to a partner interconnect, created by the partner."
 ],
@@ -62624,6 +62817,88 @@ false
 },
 "type": "object"
 },
+"InterconnectAttachmentL2Forwarding": {
+"description": "L2 Interconnect Attachment related configuration.",
+"id": "InterconnectAttachmentL2Forwarding",
+"properties": {
+"applianceMappings": {
+"additionalProperties": {
+"$ref": "InterconnectAttachmentL2ForwardingApplianceMapping"
+},
+"description": "Optional. A map of VLAN tags to appliances and optional inner mapping\nrules. If VLANs are not explicitly mapped to any appliance, the\ndefaultApplianceIpAddress is used.\n\nEach VLAN tag can be a single number or a range of numbers in the range\nof 1 to 4094, e.g., \"1\" or \"4001-4094\". Non-empty and non-overlapping\nVLAN tag ranges are enforced, and violating operations will be rejected.\n\nThe VLAN tags in the Ethernet header must use an ethertype value of\n0x88A8 or 0x8100.",
+"type": "object"
+},
+"defaultApplianceIpAddress": {
+"description": "Optional. A single IPv4 or IPv6 address used as the default destination\nIP when there is no VLAN mapping result found.\n\nUnset field (null-value) indicates the unmatched packet should be\ndropped.",
+"type": "string"
+},
+"geneveHeader": {
+"$ref": "InterconnectAttachmentL2ForwardingGeneveHeader",
+"description": "Optional. It represents the structure of a Geneve (Generic Network\nVirtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various\nprotocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization\nenvironments."
+},
+"network": {
+"description": "Required. Resource URL of the network to which this attachment belongs.",
+"type": "string"
+},
+"tunnelEndpointIpAddress": {
+"description": "Required. A single IPv4 or IPv6 address. This address will be used as the\nsource IP address for packets sent to the appliances, and must be used as\nthe destination IP address for packets that should be sent out through\nthis attachment.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingApplianceMapping": {
+"description": "Two-level VLAN-to-Appliance mapping rule.",
+"id": "InterconnectAttachmentL2ForwardingApplianceMapping",
+"properties": {
+"applianceIpAddress": {
+"description": "Optional. A single IPv4 or IPv6 address used as the destination IP\naddress for ingress packets that match on a VLAN tag, but do not match\na more specific inner VLAN tag.\n\nUnset field (null-value) indicates both VLAN tags are required to be\nmapped. Otherwise, defaultApplianceIpAddress is used.",
+"type": "string"
+},
+"innerVlanToApplianceMappings": {
+"description": "Optional. Used to match against the inner VLAN when the packet\ncontains two VLAN tags.\n\nA list of mapping rules from inner VLAN tags to IP addresses. If the\ninner VLAN is not explicitly mapped to an IP address range, the\napplianceIpAddress is used.",
+"items": {
+"$ref": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping"
+},
+"type": "array"
+},
+"name": {
+"description": "Optional. The name of this appliance mapping rule.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping": {
+"description": "The inner VLAN-to-Appliance mapping.",
+"id": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping",
+"properties": {
+"innerApplianceIpAddress": {
+"description": "Required in this object. A single IPv4 or IPv6 address used as the\ndestination IP address for ingress packets that match on both VLAN\ntags.",
+"type": "string"
+},
+"innerVlanTags": {
+"description": "Required in this object. Used to match the inner VLAN tag on the\npacket. Each entry can be a single number or a range of numbers in\nthe range of 1 to 4094, e.g., [\"1\", \"4001-4094\"] is valid. Non-empty\nand Non-overlapping VLAN tag ranges are enforced, and violating\noperations will be rejected.\n\nThe inner VLAN tags must have an ethertype value of 0x8100.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"InterconnectAttachmentL2ForwardingGeneveHeader": {
+"description": "GeneveHeader related configurations.",
+"id": "InterconnectAttachmentL2ForwardingGeneveHeader",
+"properties": {
+"vni": {
+"description": "Optional. VNI is a 24-bit unique virtual network identifier, from 0 to\n16,777,215.",
+"format": "uint32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "InterconnectAttachmentList": {
 "description": "Response to the list request, and contains a list of interconnect\nattachments.",
 "id": "InterconnectAttachmentList",
@@ -62779,6 +63054,20 @@ false
 },
 "type": "object"
 },
+"InterconnectAttachmentParams": {
+"description": "Additional interconnect attachment parameters.",
+"id": "InterconnectAttachmentParams",
+"properties": {
+"resourceManagerTags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
+"type": "object"
+}
+},
+"type": "object"
+},
 "InterconnectAttachmentPartnerMetadata": {
 "description": "Informational metadata about Partner attachments from Partners to display\nto customers.  These fields are propagated from PARTNER_PROVIDER\nattachments to their corresponding PARTNER attachments.",
 "id": "InterconnectAttachmentPartnerMetadata",
@@ -63164,7 +63453,7 @@ false
 "type": "string"
 },
 "etag": {
-"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAPI 154.",
+"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.",
 "type": "string"
 },
 "id": {
@@ -63500,10 +63789,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -63949,10 +64240,12 @@ false
 "items": {
 "enum": [
 "IF_CROSS_SITE_NETWORK",
+"IF_L2_FORWARDING",
 "IF_MACSEC"
 ],
 "enumDescriptions": [
 "Cross-Site Networking",
+"L2 Interconnect Attachment Forwarding",
 "Media Access Control security (MACsec)"
 ],
 "type": "string"
@@ -64261,6 +64554,10 @@ false
 "format": "int64",
 "type": "string"
 },
+"l2ForwardingEnabled": {
+"description": "Identifies whether L2 Interconnect Attachments can be created in this\nregion for interconnects that are in this location.",
+"type": "boolean"
+},
 "locationPresence": {
 "description": "Identifies the network presence of this location.",
 "enum": [
@@ -64432,6 +64729,20 @@ false
 },
 "type": "object"
 },
+"InterconnectParams": {
+"description": "Additional interconnect parameters.",
+"id": "InterconnectParams",
+"properties": {
+"resourceManagerTags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
+"type": "object"
+}
+},
+"type": "object"
+},
 "InterconnectRemoteLocation": {
 "description": "Represents a Cross-Cloud Interconnect Remote Location resource.\n\nYou can use this resource to find remote location details about an\nInterconnect attachment (VLAN).",
 "id": "InterconnectRemoteLocation",
@@ -68654,6 +68965,18 @@ false
 "format": "byte",
 "type": "string"
 },
+"igmpQuery": {
+"description": "Indicate whether igmp query is enabled on the network interface\nor 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",
@@ -69368,6 +69691,18 @@ false
 ],
 "type": "string"
 },
+"allowMulticast": {
+"description": "Specifies whether multicast is allowed.",
+"enum": [
+"MULTICAST_ALLOWED",
+"MULTICAST_BLOCKED"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "allowNcc": {
 "description": "Specifies whether NCC is allowed.",
 "enum": [
@@ -69511,6 +69846,18 @@ false
 },
 "type": "array"
 },
+"multicast": {
+"description": "Specifies which type of multicast is supported.",
+"enum": [
+"MULTICAST_SDN",
+"MULTICAST_ULL"
+],
+"enumDescriptions": [
+"",
+""
+],
+"type": "string"
+},
 "subnetPurposes": {
 "description": "Specifies which subnetwork purposes are supported.",
 "items": {
@@ -77841,6 +78188,20 @@ false
 "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
 "type": "string"
 },
+"protectionTier": {
+"description": "Protection tier for the workload which specifies the workload expectations\nin the event of infrastructure failures at data center (e.g. power\nand/or cooling failures).",
+"enum": [
+"CAPACITY_OPTIMIZED",
+"PROTECTION_TIER_UNSPECIFIED",
+"STANDARD"
+],
+"enumDescriptions": [
+"CAPACITY_OPTIMIZED capacity leverages redundancies (e.g. power, cooling)\nat the data center during normal operating conditions. In the event of\ninfrastructure failures at data center (e.g. power and/or cooling\nfailures), this workload may be disrupted. As a consequence, it has a\nweaker availability SLO than STANDARD.",
+"Unspecified protection tier.",
+"STANDARD protection for workload that should be protected by redundancies\n(e.g. power, cooling) at the data center level. In the event of\ninfrastructure failures at data center (e.g. power and/or cooling\nfailures), this workload is expected to continue as normal using the\nredundancies."
+],
+"type": "string"
+},
 "reservationSharingPolicy": {
 "$ref": "AllocationReservationSharingPolicy",
 "description": "Specify the reservation sharing policy. If unspecified, the reservation\nwill not be shared with Google Cloud managed services."
@@ -78628,6 +78989,10 @@ false
 "description": "Represents a reservation subBlock resource.",
 "id": "ReservationSubBlock",
 "properties": {
+"acceleratorTopologiesInfo": {
+"$ref": "AcceleratorTopologiesInfo",
+"description": "[Output Only] Slice info for the reservation subBlock."
+},
 "count": {
 "description": "[Output Only] The number of hosts that are allocated in this\nreservation subBlock.",
 "format": "int32",
@@ -78971,12 +79336,14 @@ false
 "FAULT_BEHAVIOR_UNSPECIFIED",
 "GPU_ERROR",
 "PERFORMANCE",
+"SILENT_DATA_CORRUPTION",
 "SWITCH_FAILURE"
 ],
 "enumDescriptions": [
 "",
 "The subBlock experienced a GPU error.",
 "The subBlock experienced performance issues.",
+"The subBlock experienced silent data corruption.",
 "The subBlock experienced a switch failure."
 ],
 "type": "string"
@@ -80329,7 +80696,7 @@ false
 "type": "integer"
 },
 "routeStatus": {
-"description": "[Output only] The status of the route.",
+"description": "[Output only] The status of the route. This status only applies to\ndynamic routes learned by Cloud Routers. This status is not applicable\nto static routes.",
 "enum": [
 "ACTIVE",
 "DROPPED",
@@ -85185,6 +85552,14 @@ false
 "description": "A Shielded Instance Identity.",
 "id": "ShieldedInstanceIdentity",
 "properties": {
+"eccP256EncryptionKey": {
+"$ref": "ShieldedInstanceIdentityEntry",
+"description": "An Endorsement Key (EK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM."
+},
+"eccP256SigningKey": {
+"$ref": "ShieldedInstanceIdentityEntry",
+"description": "An Attestation Key (AK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM."
+},
 "encryptionKey": {
 "$ref": "ShieldedInstanceIdentityEntry",
 "description": "An Endorsement Key (EK) made by the RSA 2048 algorithm\nissued to the Shielded Instance's vTPM."
@@ -93525,6 +93900,7 @@ false
 "FAILURE_NETWORK",
 "FAILURE_NVLINK",
 "FAILURE_REDUNDANT_HARDWARE_FAULT",
+"FAILURE_TPU",
 "INFRASTRUCTURE_RELOCATION",
 "MAINTENANCE_REASON_UNKNOWN",
 "PLANNED_NETWORK_UPDATE",
@@ -93543,6 +93919,7 @@ false
 "Maintenance due to network errors.",
 "Maintenance due to NVLink failure.",
 "Maintenance due to redundant hardware fault.",
+"Maintenance due to TPU errors.",
 "Maintenance due to infrastructure relocation.",
 "Unknown maintenance reason. Do not use this value.",
 "Maintenance due to planned network update.",

From abf00d5720427fc630a1b261b37bddf881d4aed8 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 22/70] feat(contactcenterinsights): update the api

#### contactcenterinsights:v1

The following keys were deleted:
- resources.projects.resources.locations.resources.authorizedViewSets.resources.authorizedViews.resources.conversations.methods.bulkAnalyze (Total Keys: 12)
- resources.projects.resources.locations.resources.authorizedViewSets.resources.authorizedViews.resources.conversations.resources.analyses.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.authorizedViewSets.resources.authorizedViews.resources.conversations.resources.analyses.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.authorizedViewSets.resources.authorizedViews.resources.conversations.resources.analyses.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.authorizedViewSets.resources.authorizedViews.resources.conversations.resources.analyses.methods.list (Total Keys: 18)
- resources.projects.resources.locations.resources.datasets.resources.conversations.methods.bulkAnalyze (Total Keys: 12)
- resources.projects.resources.locations.resources.datasets.resources.conversations.resources.analyses.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.datasets.resources.conversations.resources.analyses.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.datasets.resources.conversations.resources.analyses.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.datasets.resources.conversations.resources.analyses.methods.list (Total Keys: 18)

The following keys were added:
- resources.projects.resources.locations.resources.conversations.resources.segments.methods.bulkAnalyze (Total Keys: 12)
- schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.clientSentimentCategoryDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.conversationProfileDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.conversationalAgentsPlaybookDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.conversationalAgentsToolDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1Dimension.properties.mediumDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata (Total Keys: 3)
- schemas.GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata (Total Keys: 3)
- schemas.GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata (Total Keys: 4)
- schemas.GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata (Total Keys: 4)
- schemas.GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata (Total Keys: 3)
- schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.clientSentimentCategoryDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.conversationProfileDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.conversationalAgentsPlaybookDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.conversationalAgentsToolDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1alpha1Dimension.properties.mediumDimensionMetadata (Total Keys: 2)
- schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata (Total Keys: 3)
- schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata (Total Keys: 3)
- schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata (Total Keys: 4)
- schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata (Total Keys: 4)
- schemas.GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata (Total Keys: 3)
---
 ...iewSets.authorizedViews.conversations.html |  81 ---
 ...ns.authorizedViewSets.authorizedViews.html |  17 +
 ...s_v1.projects.locations.conversations.html |   5 +
 ...ects.locations.conversations.segments.html | 162 ++++++
 ...ects.locations.datasets.conversations.html |  81 ---
 ...tcenterinsights_v1.projects.locations.html |  17 +
 .../documents/contactcenterinsights.v1.json   | 540 ++++++++----------
 7 files changed, 432 insertions(+), 471 deletions(-)
 create mode 100644 docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html

diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html
index e61ef89993..e647d2a5d4 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html
@@ -74,11 +74,6 @@
 
 
Contact Center AI Insights API . projects . locations . authorizedViewSets . authorizedViews . conversations

 
Instance Methods

-

-  analyses()
-

-
Returns the analyses Resource.

-
 

   assessments()
 

@@ -89,9 +84,6 @@ 
Instance Methods

 

 
Returns the feedbackLabels Resource.

 
-

-  bulkAnalyze(parent, body=None, x__xgafv=None)

-
Analyzes multiple conversations in a single request.

 

   calculateStats(location, filter=None, x__xgafv=None)

 
Gets conversation statistics.

@@ -111,79 +103,6 @@ 
Instance Methods

   list_next()

 
Retrieves the next page of results.

 
Method Details

-

-    bulkAnalyze(parent, body=None, x__xgafv=None)
-  
Analyzes multiple conversations in a single request.
-
-Args:
-  parent: string, Required. The parent resource to create analyses in. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request to analyze conversations in bulk.
-  "analysisPercentage": 3.14, # Required. Percentage of selected conversation to analyze, between [0, 100].
-  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
-    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
-      "A String",
-    ],
-    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
-      "A String",
-    ],
-    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
-      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
-        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
-          "A String",
-        ],
-      },
-    },
-    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
-    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
-    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
-    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
-    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
-    "runQaAnnotator": True or False, # Whether to run the QA annotator.
-    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
-    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
-    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
-    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
-      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
-      "generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
-      "summarizationModel": "A String", # Default summarization model to be used.
-    },
-  },
-  "filter": "A String", # Required. Filter used to select the subset of conversations to analyze.
-  "parent": "A String", # Required. The parent resource to create analyses in.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}

-

-
 

     calculateStats(location, filter=None, x__xgafv=None)
   
Gets conversation statistics.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html
index a4a5479907..1b2f78e595 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html
@@ -358,12 +358,29 @@ 
Method Details

         "agentVersionDisplayName": "A String", # Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
         "agentVersionId": "A String", # Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
       },
+      "clientSentimentCategoryDimensionMetadata": { # Metadata about the client sentiment category dimension. # Output only. Metadata about the client sentiment category dimension.
+        "sentimentCategory": "A String", # Optional. The client sentiment category.
+      },
+      "conversationProfileDimensionMetadata": { # Metadata about the conversation profile dimension. # Output only. Metadata about the conversation profile dimension.
+        "conversationProfileId": "A String", # Optional. The conversation profile ID.
+      },
+      "conversationalAgentsPlaybookDimensionMetadata": { # Metadata about the Conversational Agents playbook dimension. # Output only. Metadata about the Conversational Agents playbook dimension.
+        "playbookDisplayName": "A String", # Optional. The dialogflow playbook display name.
+        "playbookId": "A String", # Optional. The dialogflow playbook ID.
+      },
+      "conversationalAgentsToolDimensionMetadata": { # Metadata about the Conversational Agents tool dimension. # Output only. Metadata about the Conversational Agents tool dimension.
+        "toolDisplayName": "A String", # Optional. The dialogflow tool display name.
+        "toolId": "A String", # Optional. The dialogflow tool ID.
+      },
       "dimensionKey": "A String", # The key of the dimension.
       "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension.
         "issueDisplayName": "A String", # The issue display name.
         "issueId": "A String", # The issue ID.
         "issueModelId": "A String", # The parent issue model ID.
       },
+      "mediumDimensionMetadata": { # Metadata about the conversation medium dimension. # Output only. Metadata about the conversation medium dimension.
+        "medium": "A String", # Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.
+      },
       "qaQuestionAnswerDimensionMetadata": { # Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. # Output only. Metadata about the QA question-answer dimension.
         "answerValue": "A String", # Optional. The full body of the question.
         "qaQuestionId": "A String", # Optional. The QA question ID.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
index 25dbe489db..11c9efdb25 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html
@@ -89,6 +89,11 @@ 
Instance Methods

 

 
Returns the feedbackLabels Resource.

 
+

+  segments()
+

+
Returns the segments Resource.

+
 

   bulkAnalyze(parent, body=None, x__xgafv=None)

 
Analyzes multiple conversations in a single request.

diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html
new file mode 100644
index 0000000000..308ea976f0
--- /dev/null
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html
@@ -0,0 +1,162 @@
+
+
+
+
Contact Center AI Insights API . projects . locations . conversations . segments

+
Instance Methods

+

+  bulkAnalyze(parent, body=None, x__xgafv=None)

+
Analyzes multiple conversations in a single request.

+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    bulkAnalyze(parent, body=None, x__xgafv=None)
+  
Analyzes multiple conversations in a single request.
+
+Args:
+  parent: string, Required. The parent resource to create analyses in. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to analyze conversations in bulk.
+  "analysisPercentage": 3.14, # Required. Percentage of selected conversation to analyze, between [0, 100].
+  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
+    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
+      "A String",
+    ],
+    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
+      "A String",
+    ],
+    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
+      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
+        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
+          "A String",
+        ],
+      },
+    },
+    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
+    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
+    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
+    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
+    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
+    "runQaAnnotator": True or False, # Whether to run the QA annotator.
+    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
+    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
+    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
+    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
+      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
+      "generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
+      "summarizationModel": "A String", # Default summarization model to be used.
+    },
+  },
+  "filter": "A String", # Required. Filter used to select the subset of conversations to analyze.
+  "parent": "A String", # Required. The parent resource to create analyses in.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
index a7237f3a24..e90d3aaf29 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html
@@ -74,19 +74,11 @@
 
 
Contact Center AI Insights API . projects . locations . datasets . conversations

 
Instance Methods

-

-  analyses()
-

-
Returns the analyses Resource.

-
 

   feedbackLabels()
 

 
Returns the feedbackLabels Resource.

 
-

-  bulkAnalyze(parent, body=None, x__xgafv=None)

-
Analyzes multiple conversations in a single request.

 

   bulkDelete(parent, body=None, x__xgafv=None)

 
Deletes multiple conversations in a single request.

@@ -115,79 +107,6 @@ 
Instance Methods

   sample(parent, body=None, x__xgafv=None)

 
Samples conversations based on user configuration and handles the sampled conversations for different use cases.

 
Method Details

-

-    bulkAnalyze(parent, body=None, x__xgafv=None)
-  
Analyzes multiple conversations in a single request.
-
-Args:
-  parent: string, Required. The parent resource to create analyses in. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request to analyze conversations in bulk.
-  "analysisPercentage": 3.14, # Required. Percentage of selected conversation to analyze, between [0, 100].
-  "annotatorSelector": { # Selector of all available annotators and phrase matchers to run. # To select the annotators to run and the phrase matchers to use (if any). If not specified, all annotators will be run.
-    "issueModels": [ # The issue model to run. If not provided, the most recently deployed topic model will be used. The provided issue model will only be used for inference if the issue model is deployed and if run_issue_model_annotator is set to true. If more than one issue model is provided, only the first provided issue model will be used for inference.
-      "A String",
-    ],
-    "phraseMatchers": [ # The list of phrase matchers to run. If not provided, all active phrase matchers will be used. If inactive phrase matchers are provided, they will not be used. Phrase matchers will be run only if run_phrase_matcher_annotator is set to true. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher}
-      "A String",
-    ],
-    "qaConfig": { # Configuration for the QA feature. # Configuration for the QA annotator.
-      "scorecardList": { # Container for a list of scorecards. # A manual list of scorecards to score.
-        "qaScorecardRevisions": [ # List of QaScorecardRevisions.
-          "A String",
-        ],
-      },
-    },
-    "runEntityAnnotator": True or False, # Whether to run the entity annotator.
-    "runIntentAnnotator": True or False, # Whether to run the intent annotator.
-    "runInterruptionAnnotator": True or False, # Whether to run the interruption annotator.
-    "runIssueModelAnnotator": True or False, # Whether to run the issue model annotator. A model should have already been deployed for this to take effect.
-    "runPhraseMatcherAnnotator": True or False, # Whether to run the active phrase matcher annotator(s).
-    "runQaAnnotator": True or False, # Whether to run the QA annotator.
-    "runSentimentAnnotator": True or False, # Whether to run the sentiment annotator.
-    "runSilenceAnnotator": True or False, # Whether to run the silence annotator.
-    "runSummarizationAnnotator": True or False, # Whether to run the summarization annotator.
-    "summarizationConfig": { # Configuration for summarization. # Configuration for the summarization annotator.
-      "conversationProfile": "A String", # Resource name of the Dialogflow conversation profile. Format: projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}
-      "generator": "A String", # The resource name of the existing created generator. Format: projects//locations//generators/
-      "summarizationModel": "A String", # Default summarization model to be used.
-    },
-  },
-  "filter": "A String", # Required. Filter used to select the subset of conversations to analyze.
-  "parent": "A String", # Required. The parent resource to create analyses in.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}

-

-
 

     bulkDelete(parent, body=None, x__xgafv=None)
   
Deletes multiple conversations in a single request.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html
index f214fd7572..009f8d4005 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html
@@ -494,12 +494,29 @@ 
Method Details

         "agentVersionDisplayName": "A String", # Optional. The agent's version display name. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
         "agentVersionId": "A String", # Optional. The agent's version ID. Only applicable to automated agents. This will be populated for AGENT_VERSION_ID, and AGENT_DEPLOYMENT_ID dimensions.
       },
+      "clientSentimentCategoryDimensionMetadata": { # Metadata about the client sentiment category dimension. # Output only. Metadata about the client sentiment category dimension.
+        "sentimentCategory": "A String", # Optional. The client sentiment category.
+      },
+      "conversationProfileDimensionMetadata": { # Metadata about the conversation profile dimension. # Output only. Metadata about the conversation profile dimension.
+        "conversationProfileId": "A String", # Optional. The conversation profile ID.
+      },
+      "conversationalAgentsPlaybookDimensionMetadata": { # Metadata about the Conversational Agents playbook dimension. # Output only. Metadata about the Conversational Agents playbook dimension.
+        "playbookDisplayName": "A String", # Optional. The dialogflow playbook display name.
+        "playbookId": "A String", # Optional. The dialogflow playbook ID.
+      },
+      "conversationalAgentsToolDimensionMetadata": { # Metadata about the Conversational Agents tool dimension. # Output only. Metadata about the Conversational Agents tool dimension.
+        "toolDisplayName": "A String", # Optional. The dialogflow tool display name.
+        "toolId": "A String", # Optional. The dialogflow tool ID.
+      },
       "dimensionKey": "A String", # The key of the dimension.
       "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension.
         "issueDisplayName": "A String", # The issue display name.
         "issueId": "A String", # The issue ID.
         "issueModelId": "A String", # The parent issue model ID.
       },
+      "mediumDimensionMetadata": { # Metadata about the conversation medium dimension. # Output only. Metadata about the conversation medium dimension.
+        "medium": "A String", # Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.
+      },
       "qaQuestionAnswerDimensionMetadata": { # Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. # Output only. Metadata about the QA question-answer dimension.
         "answerValue": "A String", # Optional. The full body of the question.
         "qaQuestionId": "A String", # Optional. The QA question ID.
diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json
index 0d3726c45b..f6e22961af 100644
--- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json
+++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json
@@ -1215,34 +1215,6 @@
 "resources": {
 "conversations": {
 "methods": {
-"bulkAnalyze": {
-"description": "Analyzes multiple conversations in a single request.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:bulkAnalyze",
-"httpMethod": "POST",
-"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.bulkAnalyze",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The parent resource to create analyses in.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/conversations:bulkAnalyze",
-"request": {
-"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "calculateStats": {
 "description": "Gets conversation statistics.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations:calculateStats",
@@ -1406,129 +1378,6 @@
 }
 },
 "resources": {
-"analyses": {
-"methods": {
-"create": {
-"description": "Creates an analysis. The long running operation is done when the analysis has completed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses",
-"httpMethod": "POST",
-"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The parent resource of the analysis.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/analyses",
-"request": {
-"$ref": "GoogleCloudContactcenterinsightsV1Analysis"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes an analysis.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}",
-"httpMethod": "DELETE",
-"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the analysis to delete.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets an analysis.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses/{analysesId}",
-"httpMethod": "GET",
-"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the analysis to get.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+/analyses/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleCloudContactcenterinsightsV1Analysis"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists analyses.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authorizedViewSets/{authorizedViewSetsId}/authorizedViews/{authorizedViewsId}/conversations/{conversationsId}/analyses",
-"httpMethod": "GET",
-"id": "contactcenterinsights.projects.locations.authorizedViewSets.authorizedViews.conversations.analyses.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"filter": {
-"description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The parent resource of the analyses.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/authorizedViewSets/[^/]+/authorizedViews/[^/]+/conversations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/analyses",
-"response": {
-"$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-},
 "assessments": {
 "methods": {
 "appeal": {
@@ -3140,6 +2989,38 @@
 ]
 }
 }
+},
+"segments": {
+"methods": {
+"bulkAnalyze": {
+"description": "Analyzes multiple conversations in a single request.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations/{conversationsId}/segments:bulkAnalyze",
+"httpMethod": "POST",
+"id": "contactcenterinsights.projects.locations.conversations.segments.bulkAnalyze",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource to create analyses in.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/conversations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/segments:bulkAnalyze",
+"request": {
+"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
 }
 }
 },
@@ -3432,34 +3313,6 @@
 "resources": {
 "conversations": {
 "methods": {
-"bulkAnalyze": {
-"description": "Analyzes multiple conversations in a single request.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkAnalyze",
-"httpMethod": "POST",
-"id": "contactcenterinsights.projects.locations.datasets.conversations.bulkAnalyze",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The parent resource to create analyses in.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/conversations:bulkAnalyze",
-"request": {
-"$ref": "GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "bulkDelete": {
 "description": "Deletes multiple conversations in a single request.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations:bulkDelete",
@@ -3705,129 +3558,6 @@
 }
 },
 "resources": {
-"analyses": {
-"methods": {
-"create": {
-"description": "Creates an analysis. The long running operation is done when the analysis has completed.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses",
-"httpMethod": "POST",
-"id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.create",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"parent": {
-"description": "Required. The parent resource of the analysis.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/analyses",
-"request": {
-"$ref": "GoogleCloudContactcenterinsightsV1Analysis"
-},
-"response": {
-"$ref": "GoogleLongrunningOperation"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"delete": {
-"description": "Deletes an analysis.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}",
-"httpMethod": "DELETE",
-"id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the analysis to delete.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/analyses/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleProtobufEmpty"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"get": {
-"description": "Gets an analysis.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses/{analysesId}",
-"httpMethod": "GET",
-"id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.get",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. The name of the analysis to get.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+/analyses/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}",
-"response": {
-"$ref": "GoogleCloudContactcenterinsightsV1Analysis"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"list": {
-"description": "Lists analyses.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/conversations/{conversationsId}/analyses",
-"httpMethod": "GET",
-"id": "contactcenterinsights.projects.locations.datasets.conversations.analyses.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"filter": {
-"description": "A filter to reduce results to a specific subset. Useful for querying conversations with specific properties.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "The maximum number of analyses to return in the response. If this value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "The value returned by the last `ListAnalysesResponse`; indicates that this is a continuation of a prior `ListAnalyses` call and the system should return the next page of data.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The parent resource of the analyses.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/conversations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/analyses",
-"response": {
-"$ref": "GoogleCloudContactcenterinsightsV1ListAnalysesResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-},
 "feedbackLabels": {
 "methods": {
 "create": {
@@ -5648,7 +5378,7 @@
 }
 }
 },
-"revision": "20251014",
+"revision": "20251023",
 "rootUrl": "https://contactcenterinsights.googleapis.com/",
 "schemas": {
 "GoogleCloudContactcenterinsightsV1Analysis": {
@@ -7551,6 +7281,26 @@ true
 "description": "Output only. Metadata about the agent dimension.",
 "readOnly": true
 },
+"clientSentimentCategoryDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata",
+"description": "Output only. Metadata about the client sentiment category dimension.",
+"readOnly": true
+},
+"conversationProfileDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata",
+"description": "Output only. Metadata about the conversation profile dimension.",
+"readOnly": true
+},
+"conversationalAgentsPlaybookDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata",
+"description": "Output only. Metadata about the Conversational Agents playbook dimension.",
+"readOnly": true
+},
+"conversationalAgentsToolDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata",
+"description": "Output only. Metadata about the Conversational Agents tool dimension.",
+"readOnly": true
+},
 "dimensionKey": {
 "description": "The key of the dimension.",
 "enum": [
@@ -7564,6 +7314,11 @@ true
 "QA_SCORECARD_ID",
 "CONVERSATION_PROFILE_ID",
 "MEDIUM",
+"CONVERSATIONAL_AGENTS_PLAYBOOK_ID",
+"CONVERSATIONAL_AGENTS_PLAYBOOK_NAME",
+"CONVERSATIONAL_AGENTS_TOOL_ID",
+"CONVERSATIONAL_AGENTS_TOOL_NAME",
+"CLIENT_SENTIMENT_CATEGORY",
 "AGENT_VERSION_ID",
 "AGENT_DEPLOYMENT_ID",
 "AGENT_ASSIST_SUPERVISOR_ID"
@@ -7579,6 +7334,11 @@ true
 "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.",
 "The dimension is keyed by the conversation profile ID.",
 "The dimension is keyed by the conversation medium.",
+"The dimension is keyed by the Conversational Agents playbook ID.",
+"The dimension is keyed by the Conversational Agents playbook display name.",
+"The dimension is keyed by the Conversational Agents tool ID.",
+"The dimension is keyed by the Conversational Agents tool display name.",
+"The dimension is keyed by the client sentiment category.",
 "The dimension is keyed by the agent version ID.",
 "The dimension is keyed by the agent deployment ID.",
 "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents."
@@ -7590,6 +7350,11 @@ true
 "description": "Output only. Metadata about the issue dimension.",
 "readOnly": true
 },
+"mediumDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata",
+"description": "Output only. Metadata about the conversation medium dimension.",
+"readOnly": true
+},
 "qaQuestionAnswerDimensionMetadata": {
 "$ref": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata",
 "description": "Output only. Metadata about the QA question-answer dimension.",
@@ -7643,6 +7408,58 @@ true
 },
 "type": "object"
 },
+"GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata": {
+"description": "Metadata about the client sentiment category dimension.",
+"id": "GoogleCloudContactcenterinsightsV1DimensionClientSentimentCategoryDimensionMetadata",
+"properties": {
+"sentimentCategory": {
+"description": "Optional. The client sentiment category.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata": {
+"description": "Metadata about the conversation profile dimension.",
+"id": "GoogleCloudContactcenterinsightsV1DimensionConversationProfileDimensionMetadata",
+"properties": {
+"conversationProfileId": {
+"description": "Optional. The conversation profile ID.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata": {
+"description": "Metadata about the Conversational Agents playbook dimension.",
+"id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsPlaybookDimensionMetadata",
+"properties": {
+"playbookDisplayName": {
+"description": "Optional. The dialogflow playbook display name.",
+"type": "string"
+},
+"playbookId": {
+"description": "Optional. The dialogflow playbook ID.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata": {
+"description": "Metadata about the Conversational Agents tool dimension.",
+"id": "GoogleCloudContactcenterinsightsV1DimensionConversationalAgentsToolDimensionMetadata",
+"properties": {
+"toolDisplayName": {
+"description": "Optional. The dialogflow tool display name.",
+"type": "string"
+},
+"toolId": {
+"description": "Optional. The dialogflow tool ID.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata": {
 "description": "Metadata about the issue dimension.",
 "id": "GoogleCloudContactcenterinsightsV1DimensionIssueDimensionMetadata",
@@ -7662,6 +7479,17 @@ true
 },
 "type": "object"
 },
+"GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata": {
+"description": "Metadata about the conversation medium dimension.",
+"id": "GoogleCloudContactcenterinsightsV1DimensionMediumDimensionMetadata",
+"properties": {
+"medium": {
+"description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata": {
 "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.",
 "id": "GoogleCloudContactcenterinsightsV1DimensionQaQuestionAnswerDimensionMetadata",
@@ -9527,16 +9355,12 @@ true
 "enum": [
 "PREDEFINED_QUESTION_TYPE_UNSPECIFIED",
 "CONVERSATION_OUTCOME",
-"CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE",
-"CONVERSATION_OUTCOME_CUSTOMER_SATISFACTION",
-"CONVERSATION_OUTCOME_AGENT_HELPFULNESS"
+"CONVERSATION_OUTCOME_ESCALATION_INITIATOR_ROLE"
 ],
 "enumDescriptions": [
 "The type of the predefined question is unspecified.",
 "A prebuilt classifier classfying the outcome of the conversation. For example, if the customer issue mentioned in a conversation has been resolved or not.",
-"A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent.",
-"A prebuilt classifier classfying whether the customer is satisfied with the agent's response.",
-"A prebuilt classifier classfying whether the agent is helpful to the customer."
+"A prebuilt classifier classfying the initiator of the conversation escalation. For example, if it was initiated by the customer or the agent."
 ],
 "type": "string"
 }
@@ -12094,6 +11918,26 @@ true
 "description": "Output only. Metadata about the agent dimension.",
 "readOnly": true
 },
+"clientSentimentCategoryDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata",
+"description": "Output only. Metadata about the client sentiment category dimension.",
+"readOnly": true
+},
+"conversationProfileDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata",
+"description": "Output only. Metadata about the conversation profile dimension.",
+"readOnly": true
+},
+"conversationalAgentsPlaybookDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata",
+"description": "Output only. Metadata about the Conversational Agents playbook dimension.",
+"readOnly": true
+},
+"conversationalAgentsToolDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata",
+"description": "Output only. Metadata about the Conversational Agents tool dimension.",
+"readOnly": true
+},
 "dimensionKey": {
 "description": "The key of the dimension.",
 "enum": [
@@ -12107,6 +11951,11 @@ true
 "QA_SCORECARD_ID",
 "CONVERSATION_PROFILE_ID",
 "MEDIUM",
+"CONVERSATIONAL_AGENTS_PLAYBOOK_ID",
+"CONVERSATIONAL_AGENTS_PLAYBOOK_NAME",
+"CONVERSATIONAL_AGENTS_TOOL_ID",
+"CONVERSATIONAL_AGENTS_TOOL_NAME",
+"CLIENT_SENTIMENT_CATEGORY",
 "AGENT_VERSION_ID",
 "AGENT_DEPLOYMENT_ID",
 "AGENT_ASSIST_SUPERVISOR_ID"
@@ -12122,6 +11971,11 @@ true
 "The dimension is keyed by QaScorecardIds. Note that: We only group by the ScorecardId and not the revision-id of the scorecard. This allows for showing stats for the same scorecard across different revisions. This metric is mostly only useful if querying the average normalized score per scorecard.",
 "The dimension is keyed by the conversation profile ID.",
 "The dimension is keyed by the conversation medium.",
+"The dimension is keyed by the Conversational Agents playbook ID.",
+"The dimension is keyed by the Conversational Agents playbook display name.",
+"The dimension is keyed by the Conversational Agents tool ID.",
+"The dimension is keyed by the Conversational Agents tool display name.",
+"The dimension is keyed by the client sentiment category.",
 "The dimension is keyed by the agent version ID.",
 "The dimension is keyed by the agent deployment ID.",
 "The dimension is keyed by the supervisor ID of the assigned human supervisor for virtual agents."
@@ -12133,6 +11987,11 @@ true
 "description": "Output only. Metadata about the issue dimension.",
 "readOnly": true
 },
+"mediumDimensionMetadata": {
+"$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata",
+"description": "Output only. Metadata about the conversation medium dimension.",
+"readOnly": true
+},
 "qaQuestionAnswerDimensionMetadata": {
 "$ref": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata",
 "description": "Output only. Metadata about the QA question-answer dimension.",
@@ -12186,6 +12045,58 @@ true
 },
 "type": "object"
 },
+"GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata": {
+"description": "Metadata about the client sentiment category dimension.",
+"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionClientSentimentCategoryDimensionMetadata",
+"properties": {
+"sentimentCategory": {
+"description": "Optional. The client sentiment category.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata": {
+"description": "Metadata about the conversation profile dimension.",
+"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationProfileDimensionMetadata",
+"properties": {
+"conversationProfileId": {
+"description": "Optional. The conversation profile ID.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata": {
+"description": "Metadata about the Conversational Agents playbook dimension.",
+"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsPlaybookDimensionMetadata",
+"properties": {
+"playbookDisplayName": {
+"description": "Optional. The dialogflow playbook display name.",
+"type": "string"
+},
+"playbookId": {
+"description": "Optional. The dialogflow playbook ID.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata": {
+"description": "Metadata about the Conversational Agents tool dimension.",
+"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionConversationalAgentsToolDimensionMetadata",
+"properties": {
+"toolDisplayName": {
+"description": "Optional. The dialogflow tool display name.",
+"type": "string"
+},
+"toolId": {
+"description": "Optional. The dialogflow tool ID.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata": {
 "description": "Metadata about the issue dimension.",
 "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionIssueDimensionMetadata",
@@ -12205,6 +12116,17 @@ true
 },
 "type": "object"
 },
+"GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata": {
+"description": "Metadata about the conversation medium dimension.",
+"id": "GoogleCloudContactcenterinsightsV1alpha1DimensionMediumDimensionMetadata",
+"properties": {
+"medium": {
+"description": "Optional. The conversation medium. Currently supports : PHONE_CALL, CHAT.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata": {
 "description": "Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard.",
 "id": "GoogleCloudContactcenterinsightsV1alpha1DimensionQaQuestionAnswerDimensionMetadata",

From 1fa286c4cf3c068ad7389a9f0c9d2672023d0a9a Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 23/70] feat(container): update the api

#### container:v1

The following keys were added:
- schemas.LinuxNodeConfig.properties.nodeKernelModuleLoading.$ref (Total Keys: 1)
- schemas.MaintenanceExclusionOptions.properties.endTimeBehavior.type (Total Keys: 1)
- schemas.NodeKernelModuleLoading (Total Keys: 3)

#### container:v1beta1

The following keys were added:
- schemas.BootDiskProfile (Total Keys: 6)
- schemas.ClusterUpdate.properties.desiredSecretSyncConfig.$ref (Total Keys: 1)
- schemas.DedicatedLocalSsdProfile (Total Keys: 4)
- schemas.EncryptionConfig (Total Keys: 3)
- schemas.EphemeralLocalSsdProfile (Total Keys: 6)
- schemas.LinuxNodeConfig.properties.nodeKernelModuleLoading.$ref (Total Keys: 1)
- schemas.LinuxNodeConfig.properties.swapConfig.$ref (Total Keys: 1)
- schemas.MaintenanceExclusionOptions.properties.endTimeBehavior.type (Total Keys: 1)
- schemas.NodeKernelModuleLoading (Total Keys: 3)
- schemas.NodeNetworkConfig.properties.acceleratorNetworkProfile.type (Total Keys: 1)
- schemas.SwapConfig (Total Keys: 7)
- schemas.UpgradeEvent.properties.currentEmulatedVersion.type (Total Keys: 1)
- schemas.UpgradeEvent.properties.targetEmulatedVersion.type (Total Keys: 1)
- schemas.UpgradeInfoEvent.properties.currentEmulatedVersion.type (Total Keys: 1)
- schemas.UpgradeInfoEvent.properties.targetEmulatedVersion.type (Total Keys: 1)
---
 ...tainer_v1.projects.locations.clusters.html | 530 ++++++------
 ...projects.locations.clusters.nodePools.html | 218 ++---
 docs/dyn/container_v1.projects.locations.html |   4 +-
 ...iner_v1.projects.locations.operations.html |  20 +-
 .../container_v1.projects.zones.clusters.html | 586 +++++++------
 ..._v1.projects.zones.clusters.nodePools.html | 242 +++---
 docs/dyn/container_v1.projects.zones.html     |   4 +-
 ...ontainer_v1.projects.zones.operations.html |  24 +-
 ...r_v1beta1.projects.locations.clusters.html | 730 ++++++++++------
 ...projects.locations.clusters.nodePools.html | 294 ++++---
 .../container_v1beta1.projects.locations.html |   4 +-
 ...v1beta1.projects.locations.operations.html |  20 +-
 ...ainer_v1beta1.projects.zones.clusters.html | 786 +++++++++++-------
 ...ta1.projects.zones.clusters.nodePools.html | 318 ++++---
 .../dyn/container_v1beta1.projects.zones.html |   4 +-
 ...ner_v1beta1.projects.zones.operations.html |  24 +-
 .../documents/container.v1.json               | 401 +++++----
 .../documents/container.v1beta1.json          | 515 ++++++++----
 18 files changed, 2807 insertions(+), 1917 deletions(-)

diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html
index c7cd2c4d55..d9841fdff5 100644
--- a/docs/dyn/container_v1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1.projects.locations.clusters.html
@@ -95,7 +95,7 @@ 
Instance Methods

 
Completes master IP rotation.

 

   create(parent, body=None, x__xgafv=None)

-
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

 

   delete(name, clusterId=None, projectId=None, x__xgafv=None, zone=None)

 
Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -119,7 +119,7 @@ 
Instance Methods

 
Enables or disables the ABAC authorization mechanism on a cluster.

 

   setLocations(name, body=None, x__xgafv=None)

-
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

+
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

 

   setLogging(name, body=None, x__xgafv=None)

 
Sets the logging service for a specific cluster.

@@ -196,8 +196,8 @@ 
Method Details

 { # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -227,7 +227,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -257,13 +257,13 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
 

     create(parent, body=None, x__xgafv=None)
-  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
   parent: string, The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. (required)
@@ -271,7 +271,7 @@ 
Method Details

     The object takes the form of:
 
 { # CreateClusterRequest creates a cluster.
-  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1/projects.locations.clusters)
+  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)
     "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
       "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
         "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
@@ -304,7 +304,7 @@ 
Method Details

       "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
         "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
       },
-      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
         "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
       },
       "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -353,14 +353,14 @@ 
Method Details

       },
     },
     "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
         "A String",
       ],
       "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-        "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
         "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-        "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
           "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -370,7 +370,7 @@ 
Method Details

             "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
           },
         },
-        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
         "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
           "A String",
         ],
@@ -466,7 +466,7 @@ 
Method Details

     "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
     "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
     "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
     "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
       "currentState": "A String", # Output only. The current state of etcd encryption.
       "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -514,7 +514,7 @@ 
Method Details

       "enabled": True or False, # Whether to enable the Identity Service component
     },
     "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
     "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
       "A String",
     ],
@@ -570,8 +570,8 @@ 
Method Details

     "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
       "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
     },
-    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-    "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+    "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
       "A String",
     ],
     "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -593,6 +593,7 @@ 
Method Details

           "a_key": { # Represents an arbitrary window of time.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -603,6 +604,7 @@ 
Method Details

           "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -617,8 +619,8 @@ 
Method Details

       },
       "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
       "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
     },
     "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
       "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
@@ -654,7 +656,7 @@ 
Method Details

     },
     "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
     "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-    "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
+    "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
     "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
       "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
       "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -677,7 +679,7 @@ 
Method Details

         "channel": "A String", # The Gateway API release channel to use for Gateway API.
       },
       "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
-      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
       "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration.
         "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster.
       },
@@ -685,17 +687,17 @@ 
Method Details

       "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
         "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
       },
-      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
     },
     "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
       "enabled": True or False, # Whether network policy is enabled on the cluster.
       "provider": "A String", # The selected network policy provider.
     },
     "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
         { # AcceleratorConfig represents a Hardware Accelerator request.
           "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
           "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
             "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
           },
@@ -717,7 +719,7 @@ 
Method Details

         "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
         "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
       },
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
         "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
         "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -729,7 +731,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -746,7 +748,7 @@ 
Method Details

       "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
       "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
         "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
         "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -758,7 +760,7 @@ 
Method Details

       "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
         "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
       },
-      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
         "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
           "A String",
@@ -818,6 +820,9 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -825,27 +830,27 @@ 
Method Details

         "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
       },
       "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
-      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
       "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
       "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
         "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
           "variant": "A String", # Logging variant deployed on nodes.
         },
       },
-      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
       "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
       "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
         "a_key": "A String",
       },
-      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
-      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-      "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+      "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
         "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
         "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
         "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -855,7 +860,7 @@ 
Method Details

       "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
         "a_key": "A String",
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
         "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -879,7 +884,7 @@ 
Method Details

       "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
         "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
         "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
             "key": "A String", # Key for NodeAffinity.
             "operator": "A String", # Operator for NodeAffinity.
             "values": [ # Values for NodeAffinity.
@@ -917,6 +922,9 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -978,7 +986,7 @@ 
Method Details

           "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
         },
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
         "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -993,7 +1001,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -1090,10 +1098,10 @@ 
Method Details

           },
         ],
         "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
             { # AcceleratorConfig represents a Hardware Accelerator request.
               "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
               "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                 "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
               },
@@ -1115,7 +1123,7 @@ 
Method Details

             "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
             "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
           },
-          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
             "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
             "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -1127,7 +1135,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -1144,7 +1152,7 @@ 
Method Details

           "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
           "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
             "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
           "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
             "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -1156,7 +1164,7 @@ 
Method Details

           "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
             "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
           },
-          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
             "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
               "A String",
@@ -1216,6 +1224,9 @@ 
Method Details

               "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
               "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
             },
+            "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+              "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+            },
             "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
               "a_key": "A String",
             },
@@ -1223,27 +1234,27 @@ 
Method Details

             "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
           },
           "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
-          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
           "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
           "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
             "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
               "variant": "A String", # Logging variant deployed on nodes.
             },
           },
-          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
           "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
           "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
             "a_key": "A String",
           },
-          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
             "A String",
           ],
-          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-          "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+          "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
             "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
             "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
             "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -1253,7 +1264,7 @@ 
Method Details

           "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
             "a_key": "A String",
           },
-          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
             "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
               "a_key": "A String",
             },
@@ -1277,7 +1288,7 @@ 
Method Details

           "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
             "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
             "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                 "key": "A String", # Key for NodeAffinity.
                 "operator": "A String", # Operator for NodeAffinity.
                 "values": [ # Values for NodeAffinity.
@@ -1308,11 +1319,11 @@ 
Method Details

           },
         },
         "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
           "A String",
         ],
-        "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+        "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
           "A String",
         ],
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1362,7 +1373,7 @@ 
Method Details

         },
         "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
           "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-          "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+          "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
           "type": "A String", # The type of placement.
         },
         "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1401,7 +1412,7 @@ 
Method Details

           "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
           "strategy": "A String", # Update strategy of the node pool.
         },
-        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
       },
     ],
     "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -1475,7 +1486,7 @@ 
Method Details

     },
     "status": "A String", # Output only. The current status of this cluster.
     "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.
+    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
     "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
     "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
       "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
@@ -1497,11 +1508,11 @@ 
Method Details

     "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies.
       "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
     },
-    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
   },
   "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1531,7 +1542,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1561,7 +1572,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -1572,12 +1583,12 @@ 
Method Details

 Args:
   name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`. (required)
   clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 
 Returns:
   An object of the form:
@@ -1601,7 +1612,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1631,7 +1642,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -1681,12 +1692,12 @@ 
Method Details

 Args:
   name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`. (required)
   clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 
 Returns:
   An object of the form:
@@ -1724,7 +1735,7 @@ 
Method Details

     "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
       "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -1773,14 +1784,14 @@ 
Method Details

     },
   },
   "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
       "A String",
     ],
     "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-      "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
       "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-      "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
         "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -1790,7 +1801,7 @@ 
Method Details

           "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
         },
       },
-      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
       "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
         "A String",
       ],
@@ -1886,7 +1897,7 @@ 
Method Details

   "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
   "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
   "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
   "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
     "currentState": "A String", # Output only. The current state of etcd encryption.
     "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -1934,7 +1945,7 @@ 
Method Details

     "enabled": True or False, # Whether to enable the Identity Service component
   },
   "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
   "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
     "A String",
   ],
@@ -1990,8 +2001,8 @@ 
Method Details

   "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
     "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-  "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
     "A String",
   ],
   "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -2013,6 +2024,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2023,6 +2035,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2037,8 +2050,8 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
   "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
     "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
@@ -2074,7 +2087,7 @@ 
Method Details

   },
   "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-  "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
+  "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
   "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
     "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
     "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -2097,7 +2110,7 @@ 
Method Details

       "channel": "A String", # The Gateway API release channel to use for Gateway API.
     },
     "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
-    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
     "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration.
       "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster.
     },
@@ -2105,17 +2118,17 @@ 
Method Details

     "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
       "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
     },
-    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
   },
   "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
   "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
       { # AcceleratorConfig represents a Hardware Accelerator request.
         "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
         "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
           "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
         },
@@ -2137,7 +2150,7 @@ 
Method Details

       "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
       "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
     },
-    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
     "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
       "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
       "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2149,7 +2162,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -2166,7 +2179,7 @@ 
Method Details

     "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
     "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
       "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
       "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2178,7 +2191,7 @@ 
Method Details

     "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
       "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
     },
-    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
     "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
       "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
         "A String",
@@ -2238,6 +2251,9 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2245,27 +2261,27 @@ 
Method Details

       "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     },
     "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
-    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
     "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
     "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
       "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
         "variant": "A String", # Logging variant deployed on nodes.
       },
     },
-    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
     "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
     "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
       "a_key": "A String",
     },
-    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
       "A String",
     ],
-    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-    "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+    "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
       "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
       "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
       "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2275,7 +2291,7 @@ 
Method Details

     "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
       "a_key": "A String",
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
       "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2299,7 +2315,7 @@ 
Method Details

     "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
       "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
       "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
           "key": "A String", # Key for NodeAffinity.
           "operator": "A String", # Operator for NodeAffinity.
           "values": [ # Values for NodeAffinity.
@@ -2337,6 +2353,9 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2398,7 +2417,7 @@ 
Method Details

         "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
       },
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
       "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2413,7 +2432,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -2510,10 +2529,10 @@ 
Method Details

         },
       ],
       "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -2535,7 +2554,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2547,7 +2566,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -2564,7 +2583,7 @@ 
Method Details

         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2576,7 +2595,7 @@ 
Method Details

         "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
           "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -2636,6 +2655,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -2643,27 +2665,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2673,7 +2695,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -2697,7 +2719,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -2728,11 +2750,11 @@ 
Method Details

         },
       },
       "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
         "A String",
       ],
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
         "A String",
       ],
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -2782,7 +2804,7 @@ 
Method Details

       },
       "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
         "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-        "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+        "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
         "type": "A String", # The type of placement.
       },
       "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -2821,7 +2843,7 @@ 
Method Details

         "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
         "strategy": "A String", # Update strategy of the node pool.
       },
-      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
     },
   ],
   "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -2895,7 +2917,7 @@ 
Method Details

   },
   "status": "A String", # Output only. The current status of this cluster.
   "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.
+  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
   "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
   "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
     "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
@@ -2917,7 +2939,7 @@ 
Method Details

   "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies.
     "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
   },
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
 }

 

 
@@ -2963,12 +2985,12 @@ 
Method Details

 
 Args:
   parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required)
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field.
 
 Returns:
   An object of the form:
@@ -3008,7 +3030,7 @@ 
Method Details

         "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
           "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
         },
-        "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+        "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
           "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
         },
         "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -3057,14 +3079,14 @@ 
Method Details

         },
       },
       "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-        "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+        "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
           "A String",
         ],
         "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-          "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
           "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-          "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
           "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
             "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -3074,7 +3096,7 @@ 
Method Details

               "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
             },
           },
-          "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+          "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
           "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
             "A String",
           ],
@@ -3170,7 +3192,7 @@ 
Method Details

       "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
       "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
       "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-      "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+      "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
       "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
         "currentState": "A String", # Output only. The current state of etcd encryption.
         "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -3218,7 +3240,7 @@ 
Method Details

         "enabled": True or False, # Whether to enable the Identity Service component
       },
       "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
       "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
         "A String",
       ],
@@ -3274,8 +3296,8 @@ 
Method Details

       "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
         "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
       },
-      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
         "A String",
       ],
       "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -3297,6 +3319,7 @@ 
Method Details

             "a_key": { # Represents an arbitrary window of time.
               "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
               "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+                "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
                 "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
               },
               "startTime": "A String", # The time that the window first starts.
@@ -3307,6 +3330,7 @@ 
Method Details

             "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
               "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
               "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+                "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
                 "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
               },
               "startTime": "A String", # The time that the window first starts.
@@ -3321,8 +3345,8 @@ 
Method Details

         },
         "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
         "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
       },
       "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
         "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
@@ -3358,7 +3382,7 @@ 
Method Details

       },
       "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
       "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-      "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
+      "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
       "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
         "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
         "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -3381,7 +3405,7 @@ 
Method Details

           "channel": "A String", # The Gateway API release channel to use for Gateway API.
         },
         "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
-        "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+        "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
         "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration.
           "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster.
         },
@@ -3389,17 +3413,17 @@ 
Method Details

         "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
           "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
         },
-        "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+        "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
       },
       "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
         "enabled": True or False, # Whether network policy is enabled on the cluster.
         "provider": "A String", # The selected network policy provider.
       },
       "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -3421,7 +3445,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -3433,7 +3457,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -3450,7 +3474,7 @@ 
Method Details

         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -3462,7 +3486,7 @@ 
Method Details

         "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
           "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -3522,6 +3546,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -3529,27 +3556,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -3559,7 +3586,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -3583,7 +3610,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -3621,6 +3648,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -3682,7 +3712,7 @@ 
Method Details

             "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
           },
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -3697,7 +3727,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -3794,10 +3824,10 @@ 
Method Details

             },
           ],
           "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-            "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+            "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
               { # AcceleratorConfig represents a Hardware Accelerator request.
                 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-                "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+                "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
                 "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                   "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
                 },
@@ -3819,7 +3849,7 @@ 
Method Details

               "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
               "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
             },
-            "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+            "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
             "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
               "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
               "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -3831,7 +3861,7 @@ 
Method Details

                     "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                       "A String",
                     ],
-                    "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                    "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                       "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                     },
                   },
@@ -3848,7 +3878,7 @@ 
Method Details

             "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
             "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
               "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
             "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
               "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -3860,7 +3890,7 @@ 
Method Details

             "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
               "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
             },
-            "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+            "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
             "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
               "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
                 "A String",
@@ -3920,6 +3950,9 @@ 
Method Details

                 "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
                 "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
               },
+              "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+                "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+              },
               "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
                 "a_key": "A String",
               },
@@ -3927,27 +3960,27 @@ 
Method Details

               "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
             },
             "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-              "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
-            "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+            "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
             "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
             "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
               "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
                 "variant": "A String", # Logging variant deployed on nodes.
               },
             },
-            "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+            "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
             "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
             "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
               "a_key": "A String",
             },
-            "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-            "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+            "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+            "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
               "A String",
             ],
-            "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-            "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+            "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+            "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
               "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
               "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
               "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -3957,7 +3990,7 @@ 
Method Details

             "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
               "a_key": "A String",
             },
-            "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+            "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
               "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
                 "a_key": "A String",
               },
@@ -3981,7 +4014,7 @@ 
Method Details

             "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
               "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
               "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-                { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+                { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                   "key": "A String", # Key for NodeAffinity.
                   "operator": "A String", # Operator for NodeAffinity.
                   "values": [ # Values for NodeAffinity.
@@ -4012,11 +4045,11 @@ 
Method Details

             },
           },
           "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-          "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+          "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
             "A String",
           ],
-          "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+          "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
             "A String",
           ],
           "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -4066,7 +4099,7 @@ 
Method Details

           },
           "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
             "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-            "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+            "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
             "type": "A String", # The type of placement.
           },
           "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -4105,7 +4138,7 @@ 
Method Details

             "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
             "strategy": "A String", # Update strategy of the node pool.
           },
-          "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+          "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
         },
       ],
       "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -4179,7 +4212,7 @@ 
Method Details

       },
       "status": "A String", # Output only. The current status of this cluster.
       "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.
+      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
       "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
       "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
         "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
@@ -4201,7 +4234,7 @@ 
Method Details

       "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies.
         "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
       },
-      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
     },
   ],
   "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
@@ -4252,7 +4285,7 @@ 
Method Details

     "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
       "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -4280,8 +4313,8 @@ 
Method Details

   },
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4311,7 +4344,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4341,7 +4374,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4358,8 +4391,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
   "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4389,7 +4422,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4419,13 +4452,13 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
 

     setLocations(name, body=None, x__xgafv=None)
-  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
 
 Args:
   name: string, The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. (required)
@@ -4434,12 +4467,12 @@ 
Method Details

 
 { # SetLocationsRequest sets the locations of the cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
-  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
+  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
     "A String",
   ],
   "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4469,7 +4502,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4499,7 +4532,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4516,8 +4549,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4547,7 +4580,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4577,7 +4610,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4603,6 +4636,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -4613,6 +4647,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -4621,8 +4656,8 @@ 
Method Details

     },
   },
   "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).
-  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.
+  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).
+  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.
 }
 
   x__xgafv: string, V1 error format.
@@ -4652,7 +4687,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4682,7 +4717,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4699,7 +4734,7 @@ 
Method Details

   "action": "A String", # Required. The exact form of action to be taken on the master auth.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
     "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
     "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
@@ -4707,10 +4742,10 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4740,7 +4775,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4770,7 +4805,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4787,8 +4822,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4818,7 +4853,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4848,7 +4883,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -4868,8 +4903,8 @@

Method Details

"enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4899,7 +4934,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4929,7 +4964,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -4946,11 +4981,11 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint. "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "resourceLabels": { # Required. The labels to set for that cluster. "a_key": "A String", }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4980,7 +5015,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5010,7 +5045,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -5026,9 +5061,9 @@

Method Details

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5058,7 +5093,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5088,7 +5123,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -5104,7 +5139,7 @@

Method Details

{ # UpdateClusterRequest updates the settings of a cluster. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. "podRangeInfo": [ # Output only. Information for additional pod range. @@ -5159,7 +5194,7 @@

Method Details

"httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver. @@ -5204,14 +5239,14 @@

Method Details

"evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED. }, "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools. "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. @@ -5221,7 +5256,7 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. "oauthScopes": [ # Scopes that are used by NAP when creating node pools. "A String", ], @@ -5275,7 +5310,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -5378,7 +5413,7 @@

Method Details

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration. "enabled": True or False, # Enables l4 ILB subsetting for this cluster. }, - "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. "A String", ], "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration. @@ -5535,6 +5570,9 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -5546,7 +5584,7 @@

Method Details

"A String", ], }, - "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. + "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -5689,7 +5727,7 @@

Method Details

], }, }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5719,7 +5757,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5749,7 +5787,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5766,8 +5804,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5797,7 +5835,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5827,7 +5865,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index b2ba87c2f8..61bd5575db 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -176,10 +176,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -201,7 +201,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -213,7 +213,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -230,7 +230,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -242,7 +242,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -302,6 +302,9 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -309,27 +312,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform) - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -339,7 +342,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -363,7 +366,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -394,11 +397,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -448,7 +451,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -487,11 +490,11 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). }, "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -521,7 +524,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -551,7 +554,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -563,12 +566,12 @@

Method Details

name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -592,7 +595,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -622,7 +625,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -673,12 +676,12 @@

Method Details

name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -708,10 +711,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -733,7 +736,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -745,7 +748,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -762,7 +765,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -774,7 +777,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -834,6 +837,9 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -841,27 +847,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform) - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -871,7 +877,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -895,7 +901,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -926,11 +932,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -980,7 +986,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1019,7 +1025,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). } @@ -1030,12 +1036,12 @@

Method Details

Args: parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -1067,10 +1073,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1092,7 +1098,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1104,7 +1110,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1121,7 +1127,7 @@

Method Details

"enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1133,7 +1139,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -1193,6 +1199,9 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -1200,27 +1209,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform) - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1230,7 +1239,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1254,7 +1263,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1285,11 +1294,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1339,7 +1348,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1378,7 +1387,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). }, ], } @@ -1397,9 +1406,9 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1429,7 +1438,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1459,7 +1468,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1485,8 +1494,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1516,7 +1525,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1546,7 +1555,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1571,8 +1580,8 @@

Method Details

}, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1602,7 +1611,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1632,7 +1641,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1650,8 +1659,8 @@

Method Details

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeCount": 42, # Required. The desired node count for the pool. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1681,7 +1690,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1711,7 +1720,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1725,10 +1734,10 @@

Method Details

The object takes the form of: { # UpdateNodePoolRequests update a node pool's image and/or version. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1757,7 +1766,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1781,7 +1790,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -1843,13 +1852,16 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, - "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. "A String", ], "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. @@ -1857,7 +1869,7 @@

Method Details

"variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. + "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. @@ -1895,16 +1907,16 @@

Method Details

}, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1948,7 +1960,7 @@

Method Details

"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The desired workload metadata config for the node pool. "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1978,7 +1990,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -2008,7 +2020,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.html b/docs/dyn/container_v1.projects.locations.html index 4c938ae1be..73a9dee9d9 100644 --- a/docs/dyn/container_v1.projects.locations.html +++ b/docs/dyn/container_v1.projects.locations.html @@ -102,12 +102,12 @@

Method Details

Args: name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. Returns: An object of the form: diff --git a/docs/dyn/container_v1.projects.locations.operations.html b/docs/dyn/container_v1.projects.locations.operations.html index f81fb6ffef..6c0e4e223c 100644 --- a/docs/dyn/container_v1.projects.locations.operations.html +++ b/docs/dyn/container_v1.projects.locations.operations.html @@ -99,8 +99,8 @@

Method Details

{ # CancelOperationRequest cancels a single operation. "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -127,12 +127,12 @@

Method Details

Args: name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required) operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -156,7 +156,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -186,7 +186,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -196,12 +196,12 @@

Method Details

Args: parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -230,7 +230,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -260,7 +260,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 4925c2057b..bcd5392933 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -90,7 +90,7 @@

Instance Methods

Completes master IP rotation.

create(projectId, zone, body=None, x__xgafv=None)

-

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

delete(projectId, zone, clusterId, name=None, x__xgafv=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -108,7 +108,7 @@

Instance Methods

Lists all clusters owned by a project in either the specified zone or all zones.

locations(projectId, zone, clusterId, body=None, x__xgafv=None)

-

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

+

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.

logging(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the logging service for a specific cluster.

@@ -142,8 +142,8 @@

Method Details

Sets the addons for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -181,7 +181,7 @@ 
Method Details

     "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
       "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -209,8 +209,8 @@ 
Method Details

   },
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -240,7 +240,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -270,7 +270,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -284,8 +284,8 @@

Method Details

Completes master IP rotation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -293,8 +293,8 @@ 
Method Details

 { # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -324,7 +324,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -354,22 +354,22 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
create(projectId, zone, body=None, x__xgafv=None) - 
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # CreateClusterRequest creates a cluster.
-  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1/projects.locations.clusters)
+  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)
     "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
       "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
         "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
@@ -402,7 +402,7 @@ 
Method Details

       "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
         "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
       },
-      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
         "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
       },
       "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -451,14 +451,14 @@ 
Method Details

       },
     },
     "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
         "A String",
       ],
       "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-        "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
         "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-        "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
           "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -468,7 +468,7 @@ 
Method Details

             "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
           },
         },
-        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
         "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
           "A String",
         ],
@@ -564,7 +564,7 @@ 
Method Details

     "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
     "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
     "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
     "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
       "currentState": "A String", # Output only. The current state of etcd encryption.
       "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -612,7 +612,7 @@ 
Method Details

       "enabled": True or False, # Whether to enable the Identity Service component
     },
     "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
     "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
       "A String",
     ],
@@ -668,8 +668,8 @@ 
Method Details

     "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
       "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
     },
-    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-    "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+    "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
       "A String",
     ],
     "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -691,6 +691,7 @@ 
Method Details

           "a_key": { # Represents an arbitrary window of time.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -701,6 +702,7 @@ 
Method Details

           "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -715,8 +717,8 @@ 
Method Details

       },
       "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
       "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
     },
     "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
       "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
@@ -752,7 +754,7 @@ 
Method Details

     },
     "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
     "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-    "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
+    "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
     "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
       "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
       "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -775,7 +777,7 @@ 
Method Details

         "channel": "A String", # The Gateway API release channel to use for Gateway API.
       },
       "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
-      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
       "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration.
         "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster.
       },
@@ -783,17 +785,17 @@ 
Method Details

       "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
         "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
       },
-      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
     },
     "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
       "enabled": True or False, # Whether network policy is enabled on the cluster.
       "provider": "A String", # The selected network policy provider.
     },
     "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
         { # AcceleratorConfig represents a Hardware Accelerator request.
           "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
           "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
             "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
           },
@@ -815,7 +817,7 @@ 
Method Details

         "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
         "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
       },
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
         "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
         "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -827,7 +829,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -844,7 +846,7 @@ 
Method Details

       "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
       "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
         "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
         "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -856,7 +858,7 @@ 
Method Details

       "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
         "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
       },
-      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
         "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
           "A String",
@@ -916,6 +918,9 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -923,27 +928,27 @@ 
Method Details

         "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
       },
       "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
-      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
       "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
       "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
         "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
           "variant": "A String", # Logging variant deployed on nodes.
         },
       },
-      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
       "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
       "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
         "a_key": "A String",
       },
-      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
-      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-      "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+      "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
         "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
         "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
         "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -953,7 +958,7 @@ 
Method Details

       "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
         "a_key": "A String",
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
         "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -977,7 +982,7 @@ 
Method Details

       "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
         "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
         "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
             "key": "A String", # Key for NodeAffinity.
             "operator": "A String", # Operator for NodeAffinity.
             "values": [ # Values for NodeAffinity.
@@ -1015,6 +1020,9 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -1076,7 +1084,7 @@ 
Method Details

           "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
         },
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
         "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -1091,7 +1099,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -1188,10 +1196,10 @@ 
Method Details

           },
         ],
         "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
             { # AcceleratorConfig represents a Hardware Accelerator request.
               "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
               "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                 "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
               },
@@ -1213,7 +1221,7 @@ 
Method Details

             "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
             "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
           },
-          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
             "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
             "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -1225,7 +1233,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -1242,7 +1250,7 @@ 
Method Details

           "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
           "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
             "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
           "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
             "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -1254,7 +1262,7 @@ 
Method Details

           "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
             "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
           },
-          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
             "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
               "A String",
@@ -1314,6 +1322,9 @@ 
Method Details

               "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
               "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
             },
+            "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+              "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+            },
             "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
               "a_key": "A String",
             },
@@ -1321,27 +1332,27 @@ 
Method Details

             "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
           },
           "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
-          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
           "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
           "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
             "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
               "variant": "A String", # Logging variant deployed on nodes.
             },
           },
-          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
           "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
           "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
             "a_key": "A String",
           },
-          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
             "A String",
           ],
-          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-          "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+          "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
             "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
             "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
             "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -1351,7 +1362,7 @@ 
Method Details

           "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
             "a_key": "A String",
           },
-          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
             "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
               "a_key": "A String",
             },
@@ -1375,7 +1386,7 @@ 
Method Details

           "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
             "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
             "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                 "key": "A String", # Key for NodeAffinity.
                 "operator": "A String", # Operator for NodeAffinity.
                 "values": [ # Values for NodeAffinity.
@@ -1406,11 +1417,11 @@ 
Method Details

           },
         },
         "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
           "A String",
         ],
-        "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+        "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
           "A String",
         ],
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1460,7 +1471,7 @@ 
Method Details

         },
         "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
           "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-          "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+          "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
           "type": "A String", # The type of placement.
         },
         "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1499,7 +1510,7 @@ 
Method Details

           "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
           "strategy": "A String", # Update strategy of the node pool.
         },
-        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
       },
     ],
     "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -1573,7 +1584,7 @@ 
Method Details

     },
     "status": "A String", # Output only. The current status of this cluster.
     "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.
+    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
     "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
     "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
       "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
@@ -1595,11 +1606,11 @@ 
Method Details

     "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies.
       "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
     },
-    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
   },
   "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1629,7 +1640,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1659,7 +1670,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -1668,8 +1679,8 @@

Method Details

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1699,7 +1710,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1729,7 +1740,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -1777,8 +1788,8 @@

Method Details

Gets the details of a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1822,7 +1833,7 @@ 
Method Details

     "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
       "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -1871,14 +1882,14 @@ 
Method Details

     },
   },
   "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
       "A String",
     ],
     "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-      "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
       "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-      "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
         "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -1888,7 +1899,7 @@ 
Method Details

           "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
         },
       },
-      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
       "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
         "A String",
       ],
@@ -1984,7 +1995,7 @@ 
Method Details

   "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
   "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
   "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
   "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
     "currentState": "A String", # Output only. The current state of etcd encryption.
     "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -2032,7 +2043,7 @@ 
Method Details

     "enabled": True or False, # Whether to enable the Identity Service component
   },
   "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
   "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
     "A String",
   ],
@@ -2088,8 +2099,8 @@ 
Method Details

   "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
     "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-  "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
     "A String",
   ],
   "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -2111,6 +2122,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2121,6 +2133,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2135,8 +2148,8 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
   "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
     "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
@@ -2172,7 +2185,7 @@ 
Method Details

   },
   "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-  "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
+  "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
   "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
     "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
     "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -2195,7 +2208,7 @@ 
Method Details

       "channel": "A String", # The Gateway API release channel to use for Gateway API.
     },
     "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
-    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
     "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration.
       "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster.
     },
@@ -2203,17 +2216,17 @@ 
Method Details

     "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
       "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
     },
-    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
   },
   "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
   "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
       { # AcceleratorConfig represents a Hardware Accelerator request.
         "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
         "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
           "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
         },
@@ -2235,7 +2248,7 @@ 
Method Details

       "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
       "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
     },
-    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
     "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
       "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
       "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2247,7 +2260,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -2264,7 +2277,7 @@ 
Method Details

     "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
     "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
       "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
       "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2276,7 +2289,7 @@ 
Method Details

     "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
       "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
     },
-    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
     "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
       "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
         "A String",
@@ -2336,6 +2349,9 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2343,27 +2359,27 @@ 
Method Details

       "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     },
     "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
-    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
     "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
     "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
       "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
         "variant": "A String", # Logging variant deployed on nodes.
       },
     },
-    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
     "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
     "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
       "a_key": "A String",
     },
-    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
       "A String",
     ],
-    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-    "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+    "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
       "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
       "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
       "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2373,7 +2389,7 @@ 
Method Details

     "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
       "a_key": "A String",
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
       "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2397,7 +2413,7 @@ 
Method Details

     "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
       "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
       "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
           "key": "A String", # Key for NodeAffinity.
           "operator": "A String", # Operator for NodeAffinity.
           "values": [ # Values for NodeAffinity.
@@ -2435,6 +2451,9 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2496,7 +2515,7 @@ 
Method Details

         "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
       },
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
       "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2511,7 +2530,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -2608,10 +2627,10 @@ 
Method Details

         },
       ],
       "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -2633,7 +2652,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2645,7 +2664,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -2662,7 +2681,7 @@ 
Method Details

         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2674,7 +2693,7 @@ 
Method Details

         "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
           "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -2734,6 +2753,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -2741,27 +2763,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2771,7 +2793,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -2795,7 +2817,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -2826,11 +2848,11 @@ 
Method Details

         },
       },
       "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
         "A String",
       ],
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
         "A String",
       ],
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -2880,7 +2902,7 @@ 
Method Details

       },
       "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
         "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-        "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+        "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
         "type": "A String", # The type of placement.
       },
       "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -2919,7 +2941,7 @@ 
Method Details

         "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
         "strategy": "A String", # Update strategy of the node pool.
       },
-      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
     },
   ],
   "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -2993,7 +3015,7 @@ 
Method Details

   },
   "status": "A String", # Output only. The current status of this cluster.
   "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.
+  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
   "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
   "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
     "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
@@ -3015,7 +3037,7 @@ 
Method Details

   "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies.
     "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
   },
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
 }
@@ -3024,8 +3046,8 @@

Method Details

Enables or disables the ABAC authorization mechanism on a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -3034,8 +3056,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
   "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -3065,7 +3087,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -3095,7 +3117,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -3104,8 +3126,8 @@

Method Details

Lists all clusters owned by a project in either the specified zone or all zones.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -3150,7 +3172,7 @@ 
Method Details

         "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
           "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
         },
-        "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+        "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
           "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
         },
         "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -3199,14 +3221,14 @@ 
Method Details

         },
       },
       "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-        "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+        "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
           "A String",
         ],
         "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-          "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
           "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-          "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
           "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
             "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -3216,7 +3238,7 @@ 
Method Details

               "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
             },
           },
-          "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+          "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
           "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
             "A String",
           ],
@@ -3312,7 +3334,7 @@ 
Method Details

       "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
       "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
       "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-      "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+      "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
       "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
         "currentState": "A String", # Output only. The current state of etcd encryption.
         "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -3360,7 +3382,7 @@ 
Method Details

         "enabled": True or False, # Whether to enable the Identity Service component
       },
       "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
       "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
         "A String",
       ],
@@ -3416,8 +3438,8 @@ 
Method Details

       "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
         "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
       },
-      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
         "A String",
       ],
       "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -3439,6 +3461,7 @@ 
Method Details

             "a_key": { # Represents an arbitrary window of time.
               "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
               "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+                "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
                 "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
               },
               "startTime": "A String", # The time that the window first starts.
@@ -3449,6 +3472,7 @@ 
Method Details

             "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
               "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
               "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+                "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
                 "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
               },
               "startTime": "A String", # The time that the window first starts.
@@ -3463,8 +3487,8 @@ 
Method Details

         },
         "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
         "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
       },
       "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
         "cidrBlocks": [ # cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
@@ -3500,7 +3524,7 @@ 
Method Details

       },
       "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
       "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-      "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
+      "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.
       "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
         "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
         "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -3523,7 +3547,7 @@ 
Method Details

           "channel": "A String", # The Gateway API release channel to use for Gateway API.
         },
         "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
-        "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+        "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
         "networkPerformanceConfig": { # Configuration of network bandwidth tiers # Network bandwidth tier configuration.
           "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for NodePools in the cluster.
         },
@@ -3531,17 +3555,17 @@ 
Method Details

         "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
           "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
         },
-        "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+        "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
       },
       "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
         "enabled": True or False, # Whether network policy is enabled on the cluster.
         "provider": "A String", # The selected network policy provider.
       },
       "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -3563,7 +3587,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -3575,7 +3599,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -3592,7 +3616,7 @@ 
Method Details

         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -3604,7 +3628,7 @@ 
Method Details

         "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
           "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -3664,6 +3688,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -3671,27 +3698,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -3701,7 +3728,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -3725,7 +3752,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -3763,6 +3790,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -3824,7 +3854,7 @@ 
Method Details

             "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
           },
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -3839,7 +3869,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -3936,10 +3966,10 @@ 
Method Details

             },
           ],
           "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-            "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+            "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
               { # AcceleratorConfig represents a Hardware Accelerator request.
                 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-                "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+                "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
                 "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                   "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
                 },
@@ -3961,7 +3991,7 @@ 
Method Details

               "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
               "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
             },
-            "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+            "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
             "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
               "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
               "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -3973,7 +4003,7 @@ 
Method Details

                     "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                       "A String",
                     ],
-                    "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                    "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                       "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                     },
                   },
@@ -3990,7 +4020,7 @@ 
Method Details

             "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
             "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
               "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
             "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
               "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -4002,7 +4032,7 @@ 
Method Details

             "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
               "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
             },
-            "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+            "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
             "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
               "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
                 "A String",
@@ -4062,6 +4092,9 @@ 
Method Details

                 "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
                 "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
               },
+              "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+                "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+              },
               "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
                 "a_key": "A String",
               },
@@ -4069,27 +4102,27 @@ 
Method Details

               "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
             },
             "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-              "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
-            "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+            "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
             "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
             "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
               "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
                 "variant": "A String", # Logging variant deployed on nodes.
               },
             },
-            "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+            "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
             "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
             "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
               "a_key": "A String",
             },
-            "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-            "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+            "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+            "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
               "A String",
             ],
-            "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-            "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+            "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+            "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
               "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
               "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
               "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -4099,7 +4132,7 @@ 
Method Details

             "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
               "a_key": "A String",
             },
-            "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+            "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
               "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
                 "a_key": "A String",
               },
@@ -4123,7 +4156,7 @@ 
Method Details

             "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
               "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
               "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-                { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+                { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                   "key": "A String", # Key for NodeAffinity.
                   "operator": "A String", # Operator for NodeAffinity.
                   "values": [ # Values for NodeAffinity.
@@ -4154,11 +4187,11 @@ 
Method Details

             },
           },
           "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-          "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+          "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
             "A String",
           ],
-          "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+          "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
             "A String",
           ],
           "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -4208,7 +4241,7 @@ 
Method Details

           },
           "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
             "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-            "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+            "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
             "type": "A String", # The type of placement.
           },
           "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -4247,7 +4280,7 @@ 
Method Details

             "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
             "strategy": "A String", # Update strategy of the node pool.
           },
-          "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+          "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
         },
       ],
       "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -4321,7 +4354,7 @@ 
Method Details

       },
       "status": "A String", # Output only. The current status of this cluster.
       "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.
+      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
       "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
       "userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
         "aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
@@ -4343,7 +4376,7 @@ 
Method Details

       "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in IAM policies. # Configuration for the use of Kubernetes Service Accounts in IAM policies.
         "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
       },
-      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
     },
   ],
   "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
@@ -4354,23 +4387,23 @@ 
Method Details

 
 

     locations(projectId, zone, clusterId, body=None, x__xgafv=None)
-  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLocationsRequest sets the locations of the cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
-  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
+  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
     "A String",
   ],
   "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4400,7 +4433,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4430,7 +4463,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4439,8 +4472,8 @@ 
Method Details

   
Sets the logging service for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4449,8 +4482,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4480,7 +4513,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4510,7 +4543,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4519,8 +4552,8 @@ 
Method Details

   
Updates the master for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4529,8 +4562,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version
   "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4560,7 +4593,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4590,7 +4623,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4599,8 +4632,8 @@ 
Method Details

   
Sets the monitoring service for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4609,8 +4642,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4640,7 +4673,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4670,7 +4703,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4679,8 +4712,8 @@ 
Method Details

   
Sets labels on a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4689,11 +4722,11 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "resourceLabels": { # Required. The labels to set for that cluster.
     "a_key": "A String",
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4723,7 +4756,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4753,7 +4786,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4762,8 +4795,8 @@ 
Method Details

   
Sets the maintenance policy for a cluster.
 
 Args:
-  projectId: string, Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). (required)
-  zone: string, Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. (required)
+  projectId: string, Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). (required)
+  zone: string, Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. (required)
   clusterId: string, Required. The name of the cluster to update. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4781,6 +4814,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -4791,6 +4825,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -4799,8 +4834,8 @@ 
Method Details

     },
   },
   "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).
-  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.
+  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).
+  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.
 }
 
   x__xgafv: string, V1 error format.
@@ -4830,7 +4865,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4860,7 +4895,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4869,8 +4904,8 @@ 
Method Details

   
Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4879,7 +4914,7 @@ 
Method Details

   "action": "A String", # Required. The exact form of action to be taken on the master auth.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
     "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
     "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
@@ -4887,10 +4922,10 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4920,7 +4955,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4950,7 +4985,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4959,8 +4994,8 @@ 
Method Details

   
Enables or disables Network Policy for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4972,8 +5007,8 @@ 
Method Details

     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -5003,7 +5038,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5033,7 +5068,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5042,8 +5077,8 @@ 
Method Details

   
Starts master IP rotation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5051,9 +5086,9 @@ 
Method Details

 { # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -5083,7 +5118,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5113,7 +5148,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5122,8 +5157,8 @@ 
Method Details

   
Updates the settings of a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5131,7 +5166,7 @@ 
Method Details

 { # UpdateClusterRequest updates the settings of a cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update.
     "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
       "podRangeInfo": [ # Output only. Information for additional pod range.
@@ -5186,7 +5221,7 @@ 
Method Details

       "httpLoadBalancing": { # Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
         "disabled": True or False, # Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.
       },
-      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
         "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
       },
       "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -5231,14 +5266,14 @@ 
Method Details

       "evaluationMode": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
     },
     "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
         "A String",
       ],
       "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-        "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
         "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-        "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # Specifies the node management options for NAP created node-pools.
           "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
@@ -5248,7 +5283,7 @@ 
Method Details

             "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
           },
         },
-        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
         "oauthScopes": [ # Scopes that are used by NAP when creating node pools.
           "A String",
         ],
@@ -5302,7 +5337,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -5405,7 +5440,7 @@ 
Method Details

     "desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration.
       "enabled": True or False, # Enables l4 ILB subsetting for this cluster.
     },
-    "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
+    "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
       "A String",
     ],
     "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration.
@@ -5562,6 +5597,9 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -5573,7 +5611,7 @@ 
Method Details

         "A String",
       ],
     },
-    "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
+    "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
       "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -5716,7 +5754,7 @@ 
Method Details

       ],
     },
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -5746,7 +5784,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5776,7 +5814,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
index ddd11a65bd..6f853872eb 100644
--- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
+++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html
@@ -113,8 +113,8 @@ 
Method Details

   
Sets the autoscaling settings for the specified node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -133,8 +133,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -164,7 +164,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -194,7 +194,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -208,8 +208,8 @@ 
Method Details

   
Creates a node pool for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -241,10 +241,10 @@ 
Method Details

       },
     ],
     "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
         { # AcceleratorConfig represents a Hardware Accelerator request.
           "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
           "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
             "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
           },
@@ -266,7 +266,7 @@ 
Method Details

         "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
         "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
       },
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
         "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
         "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -278,7 +278,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -295,7 +295,7 @@ 
Method Details

       "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
       "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
         "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
         "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -307,7 +307,7 @@ 
Method Details

       "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
         "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
       },
-      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
         "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
           "A String",
@@ -367,6 +367,9 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -374,27 +377,27 @@ 
Method Details

         "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
       },
       "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
-      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
       "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
       "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
         "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
           "variant": "A String", # Logging variant deployed on nodes.
         },
       },
-      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
       "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
       "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
         "a_key": "A String",
       },
-      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
-      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-      "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+      "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
         "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
         "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
         "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -404,7 +407,7 @@ 
Method Details

       "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
         "a_key": "A String",
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
         "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -428,7 +431,7 @@ 
Method Details

       "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
         "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
         "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
             "key": "A String", # Key for NodeAffinity.
             "operator": "A String", # Operator for NodeAffinity.
             "values": [ # Values for NodeAffinity.
@@ -459,11 +462,11 @@ 
Method Details

       },
     },
     "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-    "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-    "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+    "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+    "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
       "A String",
     ],
-    "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+    "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
       "A String",
     ],
     "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -513,7 +516,7 @@ 
Method Details

     },
     "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
       "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-      "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+      "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
       "type": "A String", # The type of placement.
     },
     "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -552,11 +555,11 @@ 
Method Details

       "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
       "strategy": "A String", # Update strategy of the node pool.
     },
-    "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+    "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
   },
   "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
 }
 
   x__xgafv: string, V1 error format.
@@ -586,7 +589,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -616,7 +619,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -625,8 +628,8 @@ 
Method Details

   
Deletes a node pool from a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
@@ -657,7 +660,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -687,7 +690,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -735,8 +738,8 @@ 
Method Details

   
Retrieves the requested node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
@@ -773,10 +776,10 @@ 
Method Details

     },
   ],
   "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
       { # AcceleratorConfig represents a Hardware Accelerator request.
         "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
         "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
           "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
         },
@@ -798,7 +801,7 @@ 
Method Details

       "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
       "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
     },
-    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
     "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
       "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
       "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -810,7 +813,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -827,7 +830,7 @@ 
Method Details

     "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
     "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
       "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
       "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -839,7 +842,7 @@ 
Method Details

     "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
       "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
     },
-    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
     "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
       "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
         "A String",
@@ -899,6 +902,9 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -906,27 +912,27 @@ 
Method Details

       "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     },
     "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
-    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
     "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
     "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
       "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
         "variant": "A String", # Logging variant deployed on nodes.
       },
     },
-    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
     "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
     "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
       "a_key": "A String",
     },
-    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
       "A String",
     ],
-    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-    "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+    "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
       "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
       "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
       "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -936,7 +942,7 @@ 
Method Details

     "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
       "a_key": "A String",
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
       "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -960,7 +966,7 @@ 
Method Details

     "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
       "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
       "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
           "key": "A String", # Key for NodeAffinity.
           "operator": "A String", # Operator for NodeAffinity.
           "values": [ # Values for NodeAffinity.
@@ -991,11 +997,11 @@ 
Method Details

     },
   },
   "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-  "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-  "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+  "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+  "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
     "A String",
   ],
-  "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+  "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
     "A String",
   ],
   "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1045,7 +1051,7 @@ 
Method Details

   },
   "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
     "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-    "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+    "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
     "type": "A String", # The type of placement.
   },
   "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1084,7 +1090,7 @@ 
Method Details

     "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
     "strategy": "A String", # Update strategy of the node pool.
   },
-  "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+  "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
 }

 
 
@@ -1093,8 +1099,8 @@ 
Method Details

   
Lists the node pools for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1132,10 +1138,10 @@ 
Method Details

         },
       ],
       "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -1157,7 +1163,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -1169,7 +1175,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -1186,7 +1192,7 @@ 
Method Details

         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -1198,7 +1204,7 @@ 
Method Details

         "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic in the node pool.
           "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -1258,6 +1264,9 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -1265,27 +1274,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -1295,7 +1304,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -1319,7 +1328,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -1350,11 +1359,11 @@ 
Method Details

         },
       },
       "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
         "A String",
       ],
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
         "A String",
       ],
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1404,7 +1413,7 @@ 
Method Details

       },
       "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
         "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-        "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+        "tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
         "type": "A String", # The type of placement.
       },
       "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1443,7 +1452,7 @@ 
Method Details

         "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
         "strategy": "A String", # Update strategy of the node pool.
       },
-      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
     },
   ],
 }

@@ -1454,8 +1463,8 @@ 
Method Details

   
Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1465,9 +1474,9 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1497,7 +1506,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1527,7 +1536,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1536,8 +1545,8 @@ 
Method Details

   
Sets the NodeManagement options for a node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1555,8 +1564,8 @@ 
Method Details

   },
   "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1586,7 +1595,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1616,7 +1625,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1625,8 +1634,8 @@ 
Method Details

   
Sets the size for a specific node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1637,8 +1646,8 @@ 
Method Details

   "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodeCount": 42, # Required. The desired node count for the pool.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1668,7 +1677,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1698,7 +1707,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1707,18 +1716,18 @@ 
Method Details

   
Updates the version and/or image type for the specified node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # UpdateNodePoolRequests update a node pool's image and/or version.
-  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
     { # AcceleratorConfig represents a Hardware Accelerator request.
       "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
       "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
         "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
       },
@@ -1747,7 +1756,7 @@ 
Method Details

           "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
             "A String",
           ],
-          "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Google Secret Manager (GCP) certificate configuration.
+          "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
             "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
           },
         },
@@ -1771,7 +1780,7 @@ 
Method Details

   "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
     "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
   },
-  "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+  "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
   "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
     "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
       "A String",
@@ -1833,13 +1842,16 @@ 
Method Details

       "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
       "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
     },
+    "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+      "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+    },
     "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
       "a_key": "A String",
     },
     "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
   },
-  "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
+  "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.
     "A String",
   ],
   "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
@@ -1847,7 +1859,7 @@ 
Method Details

       "variant": "A String", # Logging variant deployed on nodes.
     },
   },
-  "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.
+  "machineType": "A String", # Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.
   "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
   "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
@@ -1885,16 +1897,16 @@ 
Method Details

   },
   "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
   "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
     "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
   },
-  "resourceLabels": { # Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
+  "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
     "labels": { # Map of node label keys and node label values.
       "a_key": "A String",
     },
   },
-  "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
+  "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
     "tags": { # TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
       "a_key": "A String",
     },
@@ -1938,7 +1950,7 @@ 
Method Details

   "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The desired workload metadata config for the node pool.
     "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1968,7 +1980,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1998,7 +2010,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
diff --git a/docs/dyn/container_v1.projects.zones.html b/docs/dyn/container_v1.projects.zones.html
index a478ee8e5e..ad1a4a8d63 100644
--- a/docs/dyn/container_v1.projects.zones.html
+++ b/docs/dyn/container_v1.projects.zones.html
@@ -101,8 +101,8 @@ 
Method Details

   
Returns configuration info about the Google Kubernetes Engine service.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/container_v1.projects.zones.operations.html b/docs/dyn/container_v1.projects.zones.operations.html
index 44eae50b59..ba1fa70d5f 100644
--- a/docs/dyn/container_v1.projects.zones.operations.html
+++ b/docs/dyn/container_v1.projects.zones.operations.html
@@ -92,8 +92,8 @@ 
Method Details

   
Cancels the specified operation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
   operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -101,8 +101,8 @@ 
Method Details

 { # CancelOperationRequest cancels a single operation.
   "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.
   "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -127,8 +127,8 @@ 
Method Details

   
Gets the specified operation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.
   x__xgafv: string, V1 error format.
@@ -158,7 +158,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -188,7 +188,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -197,8 +197,8 @@ 
Method Details

   
Lists all operations in a project in a specific zone or all zones.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -232,7 +232,7 @@ 
Method Details

         ],
         "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
       },
-      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
       "name": "A String", # Output only. The server-assigned ID for the operation.
       "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
         { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -262,7 +262,7 @@ 
Method Details

       "status": "A String", # Output only. The current status of the operation.
       "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
       "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
     },
   ],
 }

diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html
index d3085fd7e8..dd54e7d45a 100644
--- a/docs/dyn/container_v1beta1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html
@@ -95,7 +95,7 @@ 
Instance Methods

 
Completes master IP rotation.

 

   create(parent, body=None, x__xgafv=None)

-
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

 

   delete(name, clusterId=None, projectId=None, x__xgafv=None, zone=None)

 
Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -119,7 +119,7 @@ 
Instance Methods

 
Enables or disables the ABAC authorization mechanism on a cluster.

 

   setLocations(name, body=None, x__xgafv=None)

-
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

+
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

 

   setLogging(name, body=None, x__xgafv=None)

 
Sets the logging service for a specific cluster.

@@ -196,8 +196,8 @@ 
Method Details

 { # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -227,7 +227,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -257,13 +257,13 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
 

     create(parent, body=None, x__xgafv=None)
-  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
   parent: string, The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. (required)
@@ -271,7 +271,7 @@ 
Method Details

     The object takes the form of:
 
 { # CreateClusterRequest creates a cluster.
-  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/projects.locations.clusters)
+  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)
     "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
       "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
         "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
@@ -311,7 +311,7 @@ 
Method Details

       "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
         "enabled": True or False, # Whether KALM is enabled for this cluster.
       },
-      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
         "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
       },
       "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -363,14 +363,14 @@ 
Method Details

       },
     },
     "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
         "A String",
       ],
       "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
         "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-        "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
           "autoRepair": True or False, # Whether the nodes will be automatically repaired.
@@ -380,8 +380,8 @@ 
Method Details

             "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
           },
         },
-        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
         "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
@@ -484,7 +484,7 @@ 
Method Details

     "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
     "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
     "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
     "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
       "currentState": "A String", # Output only. The current state of etcd encryption.
       "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -532,7 +532,7 @@ 
Method Details

       "enabled": True or False, # Whether to enable the Identity Service component
     },
     "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
     "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
       "A String",
     ],
@@ -589,8 +589,8 @@ 
Method Details

     "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
       "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
     },
-    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-    "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+    "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
       "A String",
     ],
     "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -612,6 +612,7 @@ 
Method Details

           "a_key": { # Represents an arbitrary window of time.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -622,6 +623,7 @@ 
Method Details

           "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -638,8 +640,8 @@ 
Method Details

       },
       "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
       "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
     },
     "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
       "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
@@ -676,7 +678,7 @@ 
Method Details

     },
     "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
     "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-    "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
+    "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
     "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
       "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
       "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -699,7 +701,7 @@ 
Method Details

         "channel": "A String", # The Gateway API release channel to use for Gateway API.
       },
       "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
-      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
       "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
         "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
       },
@@ -707,17 +709,17 @@ 
Method Details

       "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
         "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
       },
-      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
     },
     "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
       "enabled": True or False, # Whether network policy is enabled on the cluster.
       "provider": "A String", # The selected network policy provider.
     },
     "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
         { # AcceleratorConfig represents a Hardware Accelerator request.
           "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
           "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
             "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
           },
@@ -740,7 +742,7 @@ 
Method Details

         "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
         "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
       },
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
         "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
         "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -752,7 +754,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -768,11 +770,11 @@ 
Method Details

       "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
       "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
       "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
         "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
         "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -792,7 +794,7 @@ 
Method Details

           "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
         },
       },
-      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
         "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
           "A String",
@@ -852,6 +854,26 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
+        "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+          "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+          },
+          "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+            "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+          },
+          "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+          "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+            "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+          },
+          "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+          },
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -859,27 +881,27 @@ 
Method Details

         "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
       },
       "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
-      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
       "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
       "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
         "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
           "variant": "A String", # Logging variant deployed on nodes.
         },
       },
-      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
       "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
       "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
         "a_key": "A String",
       },
-      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
-      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-      "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+      "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
         "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
         "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
         "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -889,7 +911,7 @@ 
Method Details

       "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
         "a_key": "A String",
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
         "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -914,7 +936,7 @@ 
Method Details

       "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
         "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
         "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
             "key": "A String", # Key for NodeAffinity.
             "operator": "A String", # Operator for NodeAffinity.
             "values": [ # Values for NodeAffinity.
@@ -953,6 +975,26 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
+        "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+          "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+          },
+          "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+            "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+          },
+          "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+          "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+            "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+          },
+          "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+          },
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -1014,7 +1056,7 @@ 
Method Details

           "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
         },
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
         "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -1029,7 +1071,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -1134,10 +1176,10 @@ 
Method Details

           },
         ],
         "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
             { # AcceleratorConfig represents a Hardware Accelerator request.
               "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
               "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                 "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
               },
@@ -1160,7 +1202,7 @@ 
Method Details

             "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
             "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
           },
-          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
             "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
             "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -1172,7 +1214,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -1188,11 +1230,11 @@ 
Method Details

           "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
           "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
           "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
           "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
             "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
           "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
             "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -1212,7 +1254,7 @@ 
Method Details

               "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
             },
           },
-          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
             "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
               "A String",
@@ -1272,6 +1314,26 @@ 
Method Details

               "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
               "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
             },
+            "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+              "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+            },
+            "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+              "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+                "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+                "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+              },
+              "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+                "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+              },
+              "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+              "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+                "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+              },
+              "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+                "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+                "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+              },
+            },
             "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
               "a_key": "A String",
             },
@@ -1279,27 +1341,27 @@ 
Method Details

             "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
           },
           "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
-          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
           "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
           "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
             "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
               "variant": "A String", # Logging variant deployed on nodes.
             },
           },
-          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
           "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
           "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
             "a_key": "A String",
           },
-          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
             "A String",
           ],
-          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-          "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+          "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
             "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
             "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
             "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -1309,7 +1371,7 @@ 
Method Details

           "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
             "a_key": "A String",
           },
-          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
             "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
               "a_key": "A String",
             },
@@ -1334,7 +1396,7 @@ 
Method Details

           "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
             "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
             "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                 "key": "A String", # Key for NodeAffinity.
                 "operator": "A String", # Operator for NodeAffinity.
                 "values": [ # Values for NodeAffinity.
@@ -1366,11 +1428,11 @@ 
Method Details

           },
         },
         "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
           "A String",
         ],
-        "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+        "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
           "A String",
         ],
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1386,6 +1448,7 @@ 
Method Details

         },
         "name": "A String", # The name of the node pool.
         "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+          "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
           "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
             { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
               "network": "A String", # Name of the VPC where the additional interface belongs
@@ -1421,7 +1484,7 @@ 
Method Details

         },
         "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
           "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-          "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+          "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
           "type": "A String", # The type of placement.
         },
         "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1460,7 +1523,7 @@ 
Method Details

           "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
           "strategy": "A String", # Update strategy of the node pool.
         },
-        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
       },
     ],
     "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -1551,7 +1614,7 @@ 
Method Details

     },
     "status": "A String", # Output only. The current status of this cluster.
     "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
+    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
     "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
       "enabled": True or False, # Whether Cloud TPU integration is enabled or not.
       "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
@@ -1586,11 +1649,11 @@ 
Method Details

       "identityProvider": "A String", # identity provider is the third party identity provider.
       "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
     },
-    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
   },
   "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1620,7 +1683,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1650,7 +1713,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -1661,12 +1724,12 @@ 
Method Details

 Args:
   name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`. (required)
   clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field.
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 
 Returns:
   An object of the form:
@@ -1690,7 +1753,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1720,7 +1783,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1770,12 +1833,12 @@ 
Method Details

 Args:
   name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`. (required)
   clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field.
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 
 Returns:
   An object of the form:
@@ -1820,7 +1883,7 @@ 
Method Details

     "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
       "enabled": True or False, # Whether KALM is enabled for this cluster.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -1872,14 +1935,14 @@ 
Method Details

     },
   },
   "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
       "A String",
     ],
     "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
       "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-      "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
         "autoRepair": True or False, # Whether the nodes will be automatically repaired.
@@ -1889,8 +1952,8 @@ 
Method Details

           "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
         },
       },
-      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
       "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
@@ -1993,7 +2056,7 @@ 
Method Details

   "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
   "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
   "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
   "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
     "currentState": "A String", # Output only. The current state of etcd encryption.
     "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -2041,7 +2104,7 @@ 
Method Details

     "enabled": True or False, # Whether to enable the Identity Service component
   },
   "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
   "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
     "A String",
   ],
@@ -2098,8 +2161,8 @@ 
Method Details

   "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
     "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-  "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
     "A String",
   ],
   "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -2121,6 +2184,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2131,6 +2195,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2147,8 +2212,8 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
   "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
     "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
@@ -2185,7 +2250,7 @@ 
Method Details

   },
   "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-  "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
+  "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
   "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
     "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
     "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -2208,7 +2273,7 @@ 
Method Details

       "channel": "A String", # The Gateway API release channel to use for Gateway API.
     },
     "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
-    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
     "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
       "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
     },
@@ -2216,17 +2281,17 @@ 
Method Details

     "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
       "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
     },
-    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
   },
   "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
   "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
       { # AcceleratorConfig represents a Hardware Accelerator request.
         "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
         "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
           "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
         },
@@ -2249,7 +2314,7 @@ 
Method Details

       "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
       "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
     },
-    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
     "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
       "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
       "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2261,7 +2326,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -2277,11 +2342,11 @@ 
Method Details

     "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
     "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
     "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
       "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
       "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2301,7 +2366,7 @@ 
Method Details

         "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
       },
     },
-    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
     "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
       "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
         "A String",
@@ -2361,6 +2426,26 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
+      "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+        "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+        },
+        "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+          "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+        },
+        "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+        "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+          "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+        },
+        "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+        },
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2368,27 +2453,27 @@ 
Method Details

       "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     },
     "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
-    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
     "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
     "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
       "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
         "variant": "A String", # Logging variant deployed on nodes.
       },
     },
-    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
     "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
     "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
       "a_key": "A String",
     },
-    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
       "A String",
     ],
-    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-    "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+    "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
       "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
       "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
       "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2398,7 +2483,7 @@ 
Method Details

     "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
       "a_key": "A String",
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
       "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2423,7 +2508,7 @@ 
Method Details

     "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
       "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
       "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
           "key": "A String", # Key for NodeAffinity.
           "operator": "A String", # Operator for NodeAffinity.
           "values": [ # Values for NodeAffinity.
@@ -2462,6 +2547,26 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
+      "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+        "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+        },
+        "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+          "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+        },
+        "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+        "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+          "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+        },
+        "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+        },
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2523,7 +2628,7 @@ 
Method Details

         "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
       },
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
       "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2538,7 +2643,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -2643,10 +2748,10 @@ 
Method Details

         },
       ],
       "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -2669,7 +2774,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2681,7 +2786,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -2697,11 +2802,11 @@ 
Method Details

         "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2721,7 +2826,7 @@ 
Method Details

             "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
           },
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -2781,6 +2886,26 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
+          "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+            "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+            },
+            "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+              "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+            },
+            "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+            "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+              "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+            },
+            "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+            },
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -2788,27 +2913,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2818,7 +2943,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -2843,7 +2968,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -2875,11 +3000,11 @@ 
Method Details

         },
       },
       "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
         "A String",
       ],
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
         "A String",
       ],
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -2895,6 +3020,7 @@ 
Method Details

       },
       "name": "A String", # The name of the node pool.
       "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+        "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
         "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
           { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
             "network": "A String", # Name of the VPC where the additional interface belongs
@@ -2930,7 +3056,7 @@ 
Method Details

       },
       "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
         "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-        "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+        "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
         "type": "A String", # The type of placement.
       },
       "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -2969,7 +3095,7 @@ 
Method Details

         "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
         "strategy": "A String", # Update strategy of the node pool.
       },
-      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
     },
   ],
   "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -3060,7 +3186,7 @@ 
Method Details

   },
   "status": "A String", # Output only. The current status of this cluster.
   "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
+  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
   "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
     "enabled": True or False, # Whether Cloud TPU integration is enabled or not.
     "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
@@ -3095,7 +3221,7 @@ 
Method Details

     "identityProvider": "A String", # identity provider is the third party identity provider.
     "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
   },
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
 }
@@ -3141,12 +3267,12 @@

Method Details

Args: parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -3193,7 +3319,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver. @@ -3245,14 +3371,14 @@

Method Details

}, }, "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. @@ -3262,8 +3388,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -3366,7 +3492,7 @@

Method Details

"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -3414,7 +3540,7 @@

Method Details

"enabled": True or False, # Whether to enable the Identity Service component }, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version - "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. + "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], @@ -3471,8 +3597,8 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster. @@ -3494,6 +3620,7 @@

Method Details

"a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time. "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. }, "startTime": "A String", # The time that the window first starts. @@ -3504,6 +3631,7 @@

Method Details

"window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time. "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. }, "startTime": "A String", # The time that the window first starts. @@ -3520,8 +3648,8 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead. "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS. @@ -3558,7 +3686,7 @@

Method Details

}, "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. - "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. + "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name. "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking. "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes @@ -3581,7 +3709,7 @@

Method Details

"channel": "A String", # The Gateway API release channel to use for Gateway API. }, "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. - "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network + "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration. "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool. }, @@ -3589,17 +3717,17 @@

Method Details

"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not. }, - "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet + "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet }, "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature. "enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -3622,7 +3750,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -3634,7 +3762,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -3650,11 +3778,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -3674,7 +3802,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -3734,6 +3862,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -3741,27 +3889,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -3771,7 +3919,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3796,7 +3944,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -3835,6 +3983,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -3896,7 +4064,7 @@

Method Details

"scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -3911,7 +4079,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -4016,10 +4184,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -4042,7 +4210,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -4054,7 +4222,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -4070,11 +4238,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -4094,7 +4262,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -4154,6 +4322,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -4161,27 +4349,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -4191,7 +4379,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -4216,7 +4404,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -4248,11 +4436,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -4268,6 +4456,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -4303,7 +4492,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -4342,7 +4531,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). }, ], "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster. @@ -4433,7 +4622,7 @@

Method Details

}, "status": "A String", # Output only. The current status of this cluster. "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. - "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. + "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. @@ -4468,7 +4657,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -4526,7 +4715,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver. @@ -4554,8 +4743,8 @@

Method Details

}, "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4585,7 +4774,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4615,7 +4804,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4632,8 +4821,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster. "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4663,7 +4852,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4693,13 +4882,13 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
setLocations(name, body=None, x__xgafv=None) - 
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
 
 Args:
   name: string, The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`. (required)
@@ -4708,12 +4897,12 @@ 
Method Details

 
 { # SetLocationsRequest sets the locations of the cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
-  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
+  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
     "A String",
   ],
   "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4743,7 +4932,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4773,7 +4962,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -4790,8 +4979,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -4821,7 +5010,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4851,7 +5040,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4877,6 +5066,7 @@

Method Details

"a_key": { # Represents an arbitrary window of time. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time. "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. }, "startTime": "A String", # The time that the window first starts. @@ -4887,6 +5077,7 @@

Method Details

"window": { # Represents an arbitrary window of time. # The window of the first recurrence. "endTime": "A String", # The time that the window ends. The end time should take place after the start time. "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options. + "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time. "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion. }, "startTime": "A String", # The time that the window first starts. @@ -4895,8 +5086,8 @@

Method Details

}, }, "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). - "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. + "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). + "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. } x__xgafv: string, V1 error format. @@ -4926,7 +5117,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -4956,7 +5147,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4973,7 +5164,7 @@

Method Details

"action": "A String", # Required. The exact form of action to be taken on the master auth. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. @@ -4981,10 +5172,10 @@

Method Details

}, "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. - "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication - "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication + "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication + "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5014,7 +5205,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5044,7 +5235,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5061,8 +5252,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5092,7 +5283,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5122,7 +5313,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5142,8 +5333,8 @@

Method Details

"enabled": True or False, # Whether network policy is enabled on the cluster. "provider": "A String", # The selected network policy provider. }, - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5173,7 +5364,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5203,7 +5394,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5220,11 +5411,11 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint. "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "resourceLabels": { # Required. The labels to set for that cluster. "a_key": "A String", }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5254,7 +5445,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5284,7 +5475,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5300,9 +5491,9 @@

Method Details

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -5332,7 +5523,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -5362,7 +5553,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -5378,7 +5569,7 @@

Method Details

{ # UpdateClusterRequest updates the settings of a cluster. "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. "podRangeInfo": [ # Output only. Information for additional pod range. @@ -5440,7 +5631,7 @@

Method Details

"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications. "enabled": True or False, # Whether KALM is enabled for this cluster. }, - "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards + "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster. }, "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver. @@ -5490,14 +5681,14 @@

Method Details

], }, "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration. - "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. + "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP. "A String", ], "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' - "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead. "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. "autoRepair": True or False, # Whether the nodes will be automatically repaired. @@ -5507,8 +5698,8 @@

Method Details

"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, - "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. @@ -5564,7 +5755,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -5675,7 +5866,7 @@

Method Details

"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration. "enabled": True or False, # Enables l4 ILB subsetting for this cluster }, - "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. + "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed. "A String", ], "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration. @@ -5834,6 +6025,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -5845,7 +6056,7 @@

Method Details

"A String", ], }, - "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. + "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -5931,6 +6142,13 @@

Method Details

"rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. }, }, + "desiredSecretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets. + "enabled": True or False, # Enable/Disable Secret Sync Config. + "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. + "enabled": True or False, # Whether the rotation is enabled. + "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes. + }, + }, "desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster. "mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. @@ -6022,7 +6240,7 @@

Method Details

], }, }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -6052,7 +6270,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -6082,7 +6300,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -6099,8 +6317,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -6130,7 +6348,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -6160,7 +6378,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index e0952ffb40..15d36772f5 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -176,10 +176,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -202,7 +202,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -214,7 +214,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -230,11 +230,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -254,7 +254,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -314,6 +314,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -321,27 +341,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -351,7 +371,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -376,7 +396,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -408,11 +428,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -428,6 +448,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -463,7 +484,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -502,11 +523,11 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). }, "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. } x__xgafv: string, V1 error format. @@ -536,7 +557,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -566,7 +587,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -578,12 +599,12 @@

Method Details

name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -607,7 +628,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -637,7 +658,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -688,12 +709,12 @@

Method Details

name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -723,10 +744,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -749,7 +770,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -761,7 +782,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -777,11 +798,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -801,7 +822,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -861,6 +882,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -868,27 +909,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -898,7 +939,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -923,7 +964,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -955,11 +996,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -975,6 +1016,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1010,7 +1052,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1049,7 +1091,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). } @@ -1060,12 +1102,12 @@

Method Details

Args: parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`. (required) clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -1097,10 +1139,10 @@

Method Details

}, ], "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1123,7 +1165,7 @@

Method Details

"provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value. "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb }, - "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption + "bootDiskKmsKey": "A String", # The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node. "enabled": True or False, # Whether Confidential Nodes feature is enabled. @@ -1135,7 +1177,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1151,11 +1193,11 @@

Method Details

"effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. "enableConfidentialStorage": True or False, # Optional. Reserved for future use. "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache. - "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool. "enabled": True or False, # Whether Fast Socket features are enabled in the node pool. @@ -1175,7 +1217,7 @@

Method Details

"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance. }, }, - "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -1235,6 +1277,26 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, @@ -1242,27 +1304,27 @@

Method Details

"transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs. - "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. + "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. }, - "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. + "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node. "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration. "variant": "A String", # Logging variant deployed on nodes. }, }, - "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. + "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`. "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. "a_key": "A String", }, - "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). - "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes). - "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. + "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). + "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes). + "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. "A String", ], - "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances. - "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool. + "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. + "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool. "consumeReservationType": "A String", # Corresponds to the type of reservation consumption. "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. "values": [ # Corresponds to the label value(s) of reservation resource(s). @@ -1272,7 +1334,7 @@

Method Details

"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "a_key": "A String", }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1297,7 +1359,7 @@

Method Details

"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups. "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group. "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group. - { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). + { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity). "key": "A String", # Key for NodeAffinity. "operator": "A String", # Operator for NodeAffinity. "values": [ # Values for NodeAffinity. @@ -1329,11 +1391,11 @@

Method Details

}, }, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], - "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. + "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool. @@ -1349,6 +1411,7 @@

Method Details

}, "name": "A String", # The name of the node pool. "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1384,7 +1447,7 @@

Method Details

}, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned. - "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies + "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. @@ -1423,7 +1486,7 @@

Method Details

"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. "strategy": "A String", # Update strategy of the node pool. }, - "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version). + "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). }, ], } @@ -1442,9 +1505,9 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1474,7 +1537,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1504,7 +1567,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1530,8 +1593,8 @@

Method Details

"clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1561,7 +1624,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1591,7 +1654,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1616,8 +1679,8 @@

Method Details

}, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1647,7 +1710,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1677,7 +1740,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1695,8 +1758,8 @@

Method Details

"name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeCount": 42, # Required. The desired node count for the pool. "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -1726,7 +1789,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -1756,7 +1819,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1770,10 +1833,10 @@

Method Details

The object takes the form of: { # SetNodePoolVersionRequest updates the version of a node pool. - "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs. + "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. { # AcceleratorConfig represents a Hardware Accelerator request. "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. - "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus) + "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus) "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver. "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed. }, @@ -1803,7 +1866,7 @@

Method Details

"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000 "A String", ], - "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration. + "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration. "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest" }, }, @@ -1827,7 +1890,7 @@

Method Details

"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool. "enabled": True or False, # Whether gVNIC features are enabled in the node pool. }, - "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types. + "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. "kubeletConfig": { # Node kubelet configs. # Node kubelet configs. "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details. "A String", @@ -1889,13 +1952,33 @@

Method Details

"hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages }, + "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. + "policy": "A String", # Set the node module loading policy for nodes in the node pool. + }, + "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. + "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size. + }, + "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap. + "diskCount": "A String", # The number of physical local NVMe SSD disks to attach. + }, + "enabled": True or False, # Optional. Enables or disables swap for the node pool. + "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default. + "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted). + }, + "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage. + "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). + "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. + }, + }, "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. }, - "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. "A String", ], "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration. @@ -1907,6 +1990,7 @@

Method Details

"maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config. + "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc. "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message "network": "A String", # Name of the VPC where the additional interface belongs @@ -1942,16 +2026,16 @@

Method Details

}, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "resourceLabels": { # Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. + "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources. "labels": { # Map of node label keys and node label values. "a_key": "A String", }, }, - "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. + "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}` "a_key": "A String", }, @@ -1996,7 +2080,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -2026,7 +2110,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -2056,7 +2140,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.html b/docs/dyn/container_v1beta1.projects.locations.html index 3ca5d952d8..14abb8a8af 100644 --- a/docs/dyn/container_v1beta1.projects.locations.html +++ b/docs/dyn/container_v1beta1.projects.locations.html @@ -105,12 +105,12 @@

Method Details

Args: name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. Returns: An object of the form: diff --git a/docs/dyn/container_v1beta1.projects.locations.operations.html b/docs/dyn/container_v1beta1.projects.locations.operations.html index 7112eaafe6..ab95b615e9 100644 --- a/docs/dyn/container_v1beta1.projects.locations.operations.html +++ b/docs/dyn/container_v1beta1.projects.locations.operations.html @@ -99,8 +99,8 @@

Method Details

{ # CancelOperationRequest cancels a single operation. "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`. "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. - "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. + "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. } x__xgafv: string, V1 error format. @@ -127,12 +127,12 @@

Method Details

Args: name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`. (required) operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. Returns: An object of the form: @@ -156,7 +156,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -186,7 +186,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -196,12 +196,12 @@

Method Details

Args: parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions. (required) - projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. + projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format - zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. + zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. Returns: An object of the form: @@ -230,7 +230,7 @@

Method Details

], "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, - "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). @@ -260,7 +260,7 @@

Method Details

"status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index d6c82e5b8d..5c790781e9 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -90,7 +90,7 @@

Instance Methods

Completes master IP rotation.

create(projectId, zone, body=None, x__xgafv=None)

-

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

+

Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

delete(projectId, zone, clusterId, name=None, x__xgafv=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

@@ -108,7 +108,7 @@

Instance Methods

Lists all clusters owned by a project in either the specified zone or all zones.

locations(projectId, zone, clusterId, body=None, x__xgafv=None)

-

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

+

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

logging(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the logging service for a specific cluster.

@@ -142,8 +142,8 @@

Method Details

Sets the addons for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -188,7 +188,7 @@ 
Method Details

     "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
       "enabled": True or False, # Whether KALM is enabled for this cluster.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -216,8 +216,8 @@ 
Method Details

   },
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -247,7 +247,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -277,7 +277,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -291,8 +291,8 @@

Method Details

Completes master IP rotation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -300,8 +300,8 @@ 
Method Details

 { # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -331,7 +331,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -361,22 +361,22 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
create(projectId, zone, body=None, x__xgafv=None) - 
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
+  
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # CreateClusterRequest creates a cluster.
-  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/projects.locations.clusters)
+  "cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)
     "addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
       "cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
         "disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
@@ -416,7 +416,7 @@ 
Method Details

       "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
         "enabled": True or False, # Whether KALM is enabled for this cluster.
       },
-      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
         "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
       },
       "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -468,14 +468,14 @@ 
Method Details

       },
     },
     "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
         "A String",
       ],
       "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
         "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-        "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
           "autoRepair": True or False, # Whether the nodes will be automatically repaired.
@@ -485,8 +485,8 @@ 
Method Details

             "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
           },
         },
-        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
         "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
@@ -589,7 +589,7 @@ 
Method Details

     "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
     "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
     "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+    "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
     "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
       "currentState": "A String", # Output only. The current state of etcd encryption.
       "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -637,7 +637,7 @@ 
Method Details

       "enabled": True or False, # Whether to enable the Identity Service component
     },
     "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+    "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
     "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
       "A String",
     ],
@@ -694,8 +694,8 @@ 
Method Details

     "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
       "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
     },
-    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-    "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+    "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+    "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
       "A String",
     ],
     "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -717,6 +717,7 @@ 
Method Details

           "a_key": { # Represents an arbitrary window of time.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -727,6 +728,7 @@ 
Method Details

           "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
             "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
             "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+              "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
               "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
             },
             "startTime": "A String", # The time that the window first starts.
@@ -743,8 +745,8 @@ 
Method Details

       },
       "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
       "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+      "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+      "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
     },
     "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
       "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
@@ -781,7 +783,7 @@ 
Method Details

     },
     "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
     "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-    "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
+    "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
     "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
       "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
       "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -804,7 +806,7 @@ 
Method Details

         "channel": "A String", # The Gateway API release channel to use for Gateway API.
       },
       "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
-      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+      "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
       "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
         "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
       },
@@ -812,17 +814,17 @@ 
Method Details

       "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
         "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
       },
-      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+      "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
     },
     "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
       "enabled": True or False, # Whether network policy is enabled on the cluster.
       "provider": "A String", # The selected network policy provider.
     },
     "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
         { # AcceleratorConfig represents a Hardware Accelerator request.
           "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
           "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
             "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
           },
@@ -845,7 +847,7 @@ 
Method Details

         "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
         "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
       },
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
         "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
         "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -857,7 +859,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -873,11 +875,11 @@ 
Method Details

       "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
       "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
       "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
         "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
         "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -897,7 +899,7 @@ 
Method Details

           "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
         },
       },
-      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
         "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
           "A String",
@@ -957,6 +959,26 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
+        "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+          "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+          },
+          "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+            "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+          },
+          "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+          "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+            "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+          },
+          "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+          },
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -964,27 +986,27 @@ 
Method Details

         "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
       },
       "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
-      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
       "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
       "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
         "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
           "variant": "A String", # Logging variant deployed on nodes.
         },
       },
-      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
       "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
       "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
         "a_key": "A String",
       },
-      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
-      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-      "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+      "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
         "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
         "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
         "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -994,7 +1016,7 @@ 
Method Details

       "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
         "a_key": "A String",
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
         "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -1019,7 +1041,7 @@ 
Method Details

       "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
         "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
         "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
             "key": "A String", # Key for NodeAffinity.
             "operator": "A String", # Operator for NodeAffinity.
             "values": [ # Values for NodeAffinity.
@@ -1058,6 +1080,26 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
+        "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+          "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+          },
+          "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+            "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+          },
+          "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+          "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+            "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+          },
+          "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+          },
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -1119,7 +1161,7 @@ 
Method Details

           "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
         },
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
         "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -1134,7 +1176,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -1239,10 +1281,10 @@ 
Method Details

           },
         ],
         "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+          "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
             { # AcceleratorConfig represents a Hardware Accelerator request.
               "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+              "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
               "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                 "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
               },
@@ -1265,7 +1307,7 @@ 
Method Details

             "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
             "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
           },
-          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
             "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
             "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -1277,7 +1319,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -1293,11 +1335,11 @@ 
Method Details

           "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
           "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
           "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
           "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
             "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
           "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
             "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -1317,7 +1359,7 @@ 
Method Details

               "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
             },
           },
-          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
             "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
               "A String",
@@ -1377,6 +1419,26 @@ 
Method Details

               "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
               "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
             },
+            "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+              "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+            },
+            "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+              "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+                "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+                "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+              },
+              "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+                "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+              },
+              "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+              "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+                "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+              },
+              "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+                "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+                "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+              },
+            },
             "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
               "a_key": "A String",
             },
@@ -1384,27 +1446,27 @@ 
Method Details

             "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
           },
           "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+            "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
           },
-          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+          "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
           "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
           "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
             "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
               "variant": "A String", # Logging variant deployed on nodes.
             },
           },
-          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+          "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
           "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
           "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
             "a_key": "A String",
           },
-          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+          "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+          "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
             "A String",
           ],
-          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-          "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+          "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+          "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
             "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
             "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
             "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -1414,7 +1476,7 @@ 
Method Details

           "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
             "a_key": "A String",
           },
-          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+          "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
             "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
               "a_key": "A String",
             },
@@ -1439,7 +1501,7 @@ 
Method Details

           "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
             "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
             "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+              { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                 "key": "A String", # Key for NodeAffinity.
                 "operator": "A String", # Operator for NodeAffinity.
                 "values": [ # Values for NodeAffinity.
@@ -1471,11 +1533,11 @@ 
Method Details

           },
         },
         "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+        "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+        "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
           "A String",
         ],
-        "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+        "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
           "A String",
         ],
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1491,6 +1553,7 @@ 
Method Details

         },
         "name": "A String", # The name of the node pool.
         "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+          "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
           "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
             { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
               "network": "A String", # Name of the VPC where the additional interface belongs
@@ -1526,7 +1589,7 @@ 
Method Details

         },
         "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
           "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-          "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+          "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
           "type": "A String", # The type of placement.
         },
         "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1565,7 +1628,7 @@ 
Method Details

           "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
           "strategy": "A String", # Update strategy of the node pool.
         },
-        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+        "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
       },
     ],
     "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -1656,7 +1719,7 @@ 
Method Details

     },
     "status": "A String", # Output only. The current status of this cluster.
     "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
+    "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
     "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
       "enabled": True or False, # Whether Cloud TPU integration is enabled or not.
       "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
@@ -1691,11 +1754,11 @@ 
Method Details

       "identityProvider": "A String", # identity provider is the third party identity provider.
       "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
     },
-    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+    "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
   },
   "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1725,7 +1788,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1755,7 +1818,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -1764,8 +1827,8 @@

Method Details

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1795,7 +1858,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1825,7 +1888,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -1873,8 +1936,8 @@

Method Details

Gets the details for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1925,7 +1988,7 @@ 
Method Details

     "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
       "enabled": True or False, # Whether KALM is enabled for this cluster.
     },
-    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+    "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
       "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
     },
     "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -1977,14 +2040,14 @@ 
Method Details

     },
   },
   "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+    "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
       "A String",
     ],
     "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
       "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-      "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
         "autoRepair": True or False, # Whether the nodes will be automatically repaired.
@@ -1994,8 +2057,8 @@ 
Method Details

           "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
         },
       },
-      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
       "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
@@ -2098,7 +2161,7 @@ 
Method Details

   "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
   "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
   "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+  "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
   "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
     "currentState": "A String", # Output only. The current state of etcd encryption.
     "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -2146,7 +2209,7 @@ 
Method Details

     "enabled": True or False, # Whether to enable the Identity Service component
   },
   "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+  "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
   "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
     "A String",
   ],
@@ -2203,8 +2266,8 @@ 
Method Details

   "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
     "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-  "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
     "A String",
   ],
   "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -2226,6 +2289,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2236,6 +2300,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -2252,8 +2317,8 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
   "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
     "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
@@ -2290,7 +2355,7 @@ 
Method Details

   },
   "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-  "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
+  "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
   "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
     "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
     "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -2313,7 +2378,7 @@ 
Method Details

       "channel": "A String", # The Gateway API release channel to use for Gateway API.
     },
     "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
-    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+    "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
     "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
       "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
     },
@@ -2321,17 +2386,17 @@ 
Method Details

     "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
       "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
     },
-    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+    "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
   },
   "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
   "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
       { # AcceleratorConfig represents a Hardware Accelerator request.
         "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
         "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
           "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
         },
@@ -2354,7 +2419,7 @@ 
Method Details

       "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
       "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
     },
-    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
     "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
       "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
       "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2366,7 +2431,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -2382,11 +2447,11 @@ 
Method Details

     "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
     "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
     "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
       "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
       "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2406,7 +2471,7 @@ 
Method Details

         "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
       },
     },
-    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
     "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
       "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
         "A String",
@@ -2466,6 +2531,26 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
+      "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+        "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+        },
+        "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+          "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+        },
+        "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+        "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+          "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+        },
+        "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+        },
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2473,27 +2558,27 @@ 
Method Details

       "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     },
     "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
-    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
     "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
     "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
       "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
         "variant": "A String", # Logging variant deployed on nodes.
       },
     },
-    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
     "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
     "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
       "a_key": "A String",
     },
-    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
       "A String",
     ],
-    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-    "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+    "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
       "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
       "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
       "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2503,7 +2588,7 @@ 
Method Details

     "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
       "a_key": "A String",
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
       "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2528,7 +2613,7 @@ 
Method Details

     "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
       "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
       "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
           "key": "A String", # Key for NodeAffinity.
           "operator": "A String", # Operator for NodeAffinity.
           "values": [ # Values for NodeAffinity.
@@ -2567,6 +2652,26 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
+      "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+        "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+        },
+        "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+          "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+        },
+        "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+        "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+          "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+        },
+        "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+        },
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -2628,7 +2733,7 @@ 
Method Details

         "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
       },
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
       "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -2643,7 +2748,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -2748,10 +2853,10 @@ 
Method Details

         },
       ],
       "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -2774,7 +2879,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -2786,7 +2891,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -2802,11 +2907,11 @@ 
Method Details

         "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -2826,7 +2931,7 @@ 
Method Details

             "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
           },
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -2886,6 +2991,26 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
+          "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+            "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+            },
+            "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+              "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+            },
+            "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+            "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+              "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+            },
+            "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+            },
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -2893,27 +3018,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -2923,7 +3048,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -2948,7 +3073,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -2980,11 +3105,11 @@ 
Method Details

         },
       },
       "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
         "A String",
       ],
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
         "A String",
       ],
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -3000,6 +3125,7 @@ 
Method Details

       },
       "name": "A String", # The name of the node pool.
       "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+        "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
         "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
           { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
             "network": "A String", # Name of the VPC where the additional interface belongs
@@ -3035,7 +3161,7 @@ 
Method Details

       },
       "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
         "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-        "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+        "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
         "type": "A String", # The type of placement.
       },
       "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -3074,7 +3200,7 @@ 
Method Details

         "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
         "strategy": "A String", # Update strategy of the node pool.
       },
-      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
     },
   ],
   "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -3165,7 +3291,7 @@ 
Method Details

   },
   "status": "A String", # Output only. The current status of this cluster.
   "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
+  "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
   "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
     "enabled": True or False, # Whether Cloud TPU integration is enabled or not.
     "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
@@ -3200,7 +3326,7 @@ 
Method Details

     "identityProvider": "A String", # identity provider is the third party identity provider.
     "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
   },
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
 }
@@ -3209,8 +3335,8 @@

Method Details

Enables or disables the ABAC authorization mechanism on a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -3219,8 +3345,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
   "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -3250,7 +3376,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -3280,7 +3406,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }
@@ -3289,8 +3415,8 @@

Method Details

Lists all clusters owned by a project in either the specified zone or all zones.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -3342,7 +3468,7 @@ 
Method Details

         "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
           "enabled": True or False, # Whether KALM is enabled for this cluster.
         },
-        "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+        "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
           "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
         },
         "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -3394,14 +3520,14 @@ 
Method Details

         },
       },
       "autoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-        "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+        "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
           "A String",
         ],
         "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+          "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
           "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
           "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-          "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+          "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
           "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
           "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
             "autoRepair": True or False, # Whether the nodes will be automatically repaired.
@@ -3411,8 +3537,8 @@ 
Method Details

               "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
             },
           },
-          "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
-          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+          "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+          "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
             "A String",
           ],
           "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
@@ -3515,7 +3641,7 @@ 
Method Details

       "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
       "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
       "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
-      "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+      "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
       "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
         "currentState": "A String", # Output only. The current state of etcd encryption.
         "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -3563,7 +3689,7 @@ 
Method Details

         "enabled": True or False, # Whether to enable the Identity Service component
       },
       "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
-      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
+      "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
       "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
         "A String",
       ],
@@ -3620,8 +3746,8 @@ 
Method Details

       "legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
         "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
       },
-      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
+      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
         "A String",
       ],
       "loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
@@ -3643,6 +3769,7 @@ 
Method Details

             "a_key": { # Represents an arbitrary window of time.
               "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
               "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+                "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
                 "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
               },
               "startTime": "A String", # The time that the window first starts.
@@ -3653,6 +3780,7 @@ 
Method Details

             "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
               "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
               "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+                "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
                 "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
               },
               "startTime": "A String", # The time that the window first starts.
@@ -3669,8 +3797,8 @@ 
Method Details

         },
         "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
         "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+        "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+        "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
       },
       "masterAuthorizedNetworksConfig": { # Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
         "cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
@@ -3707,7 +3835,7 @@ 
Method Details

       },
       "monitoringService": "A String", # The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
       "name": "A String", # The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.
-      "network": "A String", # The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
+      "network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
       "networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
         "datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
         "defaultEnablePrivateNodes": True or False, # Controls whether by default nodes have private IP addresses only. It is invalid to specify both PrivateClusterConfig.enablePrivateNodes and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
@@ -3730,7 +3858,7 @@ 
Method Details

           "channel": "A String", # The Gateway API release channel to use for Gateway API.
         },
         "inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
-        "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
+        "network": "A String", # Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
         "networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
           "totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
         },
@@ -3738,17 +3866,17 @@ 
Method Details

         "serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
           "enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
         },
-        "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
+        "subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
       },
       "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
         "enabled": True or False, # Whether network policy is enabled on the cluster.
         "provider": "A String", # The selected network policy provider.
       },
       "nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -3771,7 +3899,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -3783,7 +3911,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -3799,11 +3927,11 @@ 
Method Details

         "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -3823,7 +3951,7 @@ 
Method Details

             "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
           },
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -3883,6 +4011,26 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
+          "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+            "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+            },
+            "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+              "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+            },
+            "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+            "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+              "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+            },
+            "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+            },
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -3890,27 +4038,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -3920,7 +4068,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -3945,7 +4093,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -3984,6 +4132,26 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
+          "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+            "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+            },
+            "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+              "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+            },
+            "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+            "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+              "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+            },
+            "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+            },
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -4045,7 +4213,7 @@ 
Method Details

             "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes
           },
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
           "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -4060,7 +4228,7 @@ 
Method Details

                   "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                     "A String",
                   ],
-                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                  "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                     "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                   },
                 },
@@ -4165,10 +4333,10 @@ 
Method Details

             },
           ],
           "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-            "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+            "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
               { # AcceleratorConfig represents a Hardware Accelerator request.
                 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-                "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+                "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
                 "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
                   "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
                 },
@@ -4191,7 +4359,7 @@ 
Method Details

               "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
               "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
             },
-            "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+            "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
             "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
               "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
               "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -4203,7 +4371,7 @@ 
Method Details

                     "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                       "A String",
                     ],
-                    "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                    "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                       "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                     },
                   },
@@ -4219,11 +4387,11 @@ 
Method Details

             "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
             "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
             "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
             "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
               "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
             "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
               "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -4243,7 +4411,7 @@ 
Method Details

                 "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
               },
             },
-            "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+            "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
             "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
               "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
                 "A String",
@@ -4303,6 +4471,26 @@ 
Method Details

                 "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
                 "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
               },
+              "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+                "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+              },
+              "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+                "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+                  "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+                  "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+                },
+                "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+                  "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+                },
+                "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+                "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+                  "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+                },
+                "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+                  "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+                  "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+                },
+              },
               "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
                 "a_key": "A String",
               },
@@ -4310,27 +4498,27 @@ 
Method Details

               "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
             },
             "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-              "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+              "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
             },
-            "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+            "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
             "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
             "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
               "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
                 "variant": "A String", # Logging variant deployed on nodes.
               },
             },
-            "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+            "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
             "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
             "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
               "a_key": "A String",
             },
-            "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-            "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+            "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+            "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+            "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
               "A String",
             ],
-            "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-            "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+            "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+            "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
               "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
               "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
               "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -4340,7 +4528,7 @@ 
Method Details

             "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
               "a_key": "A String",
             },
-            "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+            "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
               "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
                 "a_key": "A String",
               },
@@ -4365,7 +4553,7 @@ 
Method Details

             "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
               "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
               "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-                { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+                { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
                   "key": "A String", # Key for NodeAffinity.
                   "operator": "A String", # Operator for NodeAffinity.
                   "values": [ # Values for NodeAffinity.
@@ -4397,11 +4585,11 @@ 
Method Details

             },
           },
           "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-          "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+          "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+          "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
             "A String",
           ],
-          "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+          "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
             "A String",
           ],
           "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -4417,6 +4605,7 @@ 
Method Details

           },
           "name": "A String", # The name of the node pool.
           "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+            "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
             "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
               { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
                 "network": "A String", # Name of the VPC where the additional interface belongs
@@ -4452,7 +4641,7 @@ 
Method Details

           },
           "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
             "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-            "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+            "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
             "type": "A String", # The type of placement.
           },
           "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -4491,7 +4680,7 @@ 
Method Details

             "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
             "strategy": "A String", # Update strategy of the node pool.
           },
-          "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+          "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
         },
       ],
       "notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
@@ -4582,7 +4771,7 @@ 
Method Details

       },
       "status": "A String", # Output only. The current status of this cluster.
       "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
-      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
+      "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
       "tpuConfig": { # Configuration for Cloud TPU. This message is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25. # Configuration for Cloud TPU support; This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
         "enabled": True or False, # Whether Cloud TPU integration is enabled or not.
         "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
@@ -4617,7 +4806,7 @@ 
Method Details

         "identityProvider": "A String", # identity provider is the third party identity provider.
         "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
       },
-      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
     },
   ],
   "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
@@ -4628,23 +4817,23 @@ 
Method Details

 
 

     locations(projectId, zone, clusterId, body=None, x__xgafv=None)
-  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
+  
Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetLocationsRequest sets the locations of the cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
-  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
+  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
     "A String",
   ],
   "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4674,7 +4863,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4704,7 +4893,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 

 
@@ -4713,8 +4902,8 @@ 
Method Details

   
Sets the logging service for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4723,8 +4912,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "loggingService": "A String", # Required. The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4754,7 +4943,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4784,7 +4973,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4793,8 +4982,8 @@ 
Method Details

   
Updates the master for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4803,8 +4992,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "masterVersion": "A String", # Required. The Kubernetes version to change the master to. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the default Kubernetes version
   "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4834,7 +5023,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4864,7 +5053,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4873,8 +5062,8 @@ 
Method Details

   
Sets the monitoring service for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4883,8 +5072,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "monitoringService": "A String", # Required. The monitoring service the cluster should use to write metrics. Currently available options: * `monitoring.googleapis.com/kubernetes` - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions.
   "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4914,7 +5103,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -4944,7 +5133,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -4953,8 +5142,8 @@ 
Method Details

   
Sets labels on a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -4963,11 +5152,11 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.
   "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "resourceLabels": { # Required. The labels to set for that cluster.
     "a_key": "A String",
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -4997,7 +5186,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5027,7 +5216,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5036,8 +5225,8 @@ 
Method Details

   
Sets the maintenance policy for a cluster.
 
 Args:
-  projectId: string, Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). (required)
-  zone: string, Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. (required)
+  projectId: string, Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). (required)
+  zone: string, Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. (required)
   clusterId: string, Required. The name of the cluster to update. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5055,6 +5244,7 @@ 
Method Details

         "a_key": { # Represents an arbitrary window of time.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -5065,6 +5255,7 @@ 
Method Details

         "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
           "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
           "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
+            "endTimeBehavior": "A String", # EndTimeBehavior specifies the behavior of the exclusion end time.
             "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
           },
           "startTime": "A String", # The time that the window first starts.
@@ -5073,8 +5264,8 @@ 
Method Details

     },
   },
   "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).
-  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.
+  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).
+  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.
 }
 
   x__xgafv: string, V1 error format.
@@ -5104,7 +5295,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5134,7 +5325,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5143,8 +5334,8 @@ 
Method Details

   
Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5153,7 +5344,7 @@ 
Method Details

   "action": "A String", # Required. The exact form of action to be taken on the master auth.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
     "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
     "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
@@ -5161,10 +5352,10 @@ 
Method Details

     },
     "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
     "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
-    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
-    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication
+    "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
+    "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -5194,7 +5385,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5224,7 +5415,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5233,8 +5424,8 @@ 
Method Details

   
Enables or disables Network Policy for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5246,8 +5437,8 @@ 
Method Details

     "enabled": True or False, # Whether network policy is enabled on the cluster.
     "provider": "A String", # The selected network policy provider.
   },
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -5277,7 +5468,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5307,7 +5498,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5316,8 +5507,8 @@ 
Method Details

   
Starts master IP rotation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5325,9 +5516,9 @@ 
Method Details

 { # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
   "clusterId": "A String", # Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -5357,7 +5548,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -5387,7 +5578,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -5396,8 +5587,8 @@ 
Method Details

   
Updates the settings for a specific cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -5405,7 +5596,7 @@ 
Method Details

 { # UpdateClusterRequest updates the settings of a cluster.
   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update.
     "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
       "podRangeInfo": [ # Output only. Information for additional pod range.
@@ -5467,7 +5658,7 @@ 
Method Details

       "kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
         "enabled": True or False, # Whether KALM is enabled for this cluster.
       },
-      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards
+      "kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
         "disabled": True or False, # Whether the Kubernetes Dashboard is enabled for this cluster.
       },
       "lustreCsiDriverConfig": { # Configuration for the Lustre CSI driver. # Configuration for the Lustre CSI driver.
@@ -5517,14 +5708,14 @@ 
Method Details

       ],
     },
     "desiredClusterAutoscaling": { # ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. # Cluster-level autoscaling configuration.
-      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
+      "autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
         "A String",
       ],
       "autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
         "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
-        "imageType": "A String", # The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "insecureKubeletReadonlyPortEnabled": True or False, # DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.
         "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
           "autoRepair": True or False, # Whether the nodes will be automatically repaired.
@@ -5534,8 +5725,8 @@ 
Method Details

             "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
           },
         },
-        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
         "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
@@ -5591,7 +5782,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -5702,7 +5893,7 @@ 
Method Details

     "desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration.
       "enabled": True or False, # Enables l4 ILB subsetting for this cluster
     },
-    "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
+    "desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
       "A String",
     ],
     "desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration.
@@ -5861,6 +6052,26 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
+      "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+        "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+        },
+        "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+          "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+        },
+        "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+        "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+          "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+        },
+        "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+        },
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -5872,7 +6083,7 @@ 
Method Details

         "A String",
       ],
     },
-    "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
+    "desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
       "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -5958,6 +6169,13 @@ 
Method Details

         "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
       },
     },
+    "desiredSecretSyncConfig": { # Configuration for sync Secret Manager secrets as k8s secrets. # Configuration for sync Secret Manager secrets as k8s secrets.
+      "enabled": True or False, # Enable/Disable Secret Sync Config.
+      "rotationConfig": { # SyncRotationConfig is config for secret manager auto rotation. # Rotation config for secret manager.
+        "enabled": True or False, # Whether the rotation is enabled.
+        "rotationInterval": "A String", # The interval between two consecutive rotations. Default rotation interval is 2 minutes.
+      },
+    },
     "desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
       "mode": "A String", # Sets which mode to use for Security Posture features.
       "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
@@ -6049,7 +6267,7 @@ 
Method Details

       ],
     },
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -6079,7 +6297,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -6109,7 +6327,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
index b6dfdd63ac..f77faf9638 100644
--- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
+++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html
@@ -113,8 +113,8 @@ 
Method Details

   
Sets the autoscaling settings of a specific node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -133,8 +133,8 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set autoscaler settings. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -164,7 +164,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -194,7 +194,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -208,8 +208,8 @@ 
Method Details

   
Creates a node pool for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -241,10 +241,10 @@ 
Method Details

       },
     ],
     "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+      "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
         { # AcceleratorConfig represents a Hardware Accelerator request.
           "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+          "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
           "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
             "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
           },
@@ -267,7 +267,7 @@ 
Method Details

         "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
         "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
       },
-      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+      "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
       "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
         "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
         "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -279,7 +279,7 @@ 
Method Details

               "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                 "A String",
               ],
-              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+              "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                 "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
               },
             },
@@ -295,11 +295,11 @@ 
Method Details

       "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
       "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
       "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
         "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
       "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
         "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -319,7 +319,7 @@ 
Method Details

           "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
         },
       },
-      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+      "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
       "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
         "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
           "A String",
@@ -379,6 +379,26 @@ 
Method Details

           "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
           "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
         },
+        "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+          "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+        },
+        "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+          "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+          },
+          "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+            "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+          },
+          "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+          "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+            "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+          },
+          "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+            "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+            "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+          },
+        },
         "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
           "a_key": "A String",
         },
@@ -386,27 +406,27 @@ 
Method Details

         "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
       },
       "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+        "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
       },
-      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+      "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
       "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
       "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
         "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
           "variant": "A String", # Logging variant deployed on nodes.
         },
       },
-      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+      "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
       "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
       "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
         "a_key": "A String",
       },
-      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+      "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+      "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+      "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
         "A String",
       ],
-      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-      "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+      "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+      "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
         "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
         "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
         "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -416,7 +436,7 @@ 
Method Details

       "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
         "a_key": "A String",
       },
-      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+      "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
         "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
           "a_key": "A String",
         },
@@ -441,7 +461,7 @@ 
Method Details

       "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
         "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
         "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+          { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
             "key": "A String", # Key for NodeAffinity.
             "operator": "A String", # Operator for NodeAffinity.
             "values": [ # Values for NodeAffinity.
@@ -473,11 +493,11 @@ 
Method Details

       },
     },
     "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-    "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-    "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+    "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+    "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
       "A String",
     ],
-    "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+    "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
       "A String",
     ],
     "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -493,6 +513,7 @@ 
Method Details

     },
     "name": "A String", # The name of the node pool.
     "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+      "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
       "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
         { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
           "network": "A String", # Name of the VPC where the additional interface belongs
@@ -528,7 +549,7 @@ 
Method Details

     },
     "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
       "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-      "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+      "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
       "type": "A String", # The type of placement.
     },
     "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -567,11 +588,11 @@ 
Method Details

       "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
       "strategy": "A String", # Update strategy of the node pool.
     },
-    "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+    "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
   },
   "parent": "A String", # The parent (project, location, cluster name) where the node pool will be created. Specified in the format `projects/*/locations/*/clusters/*`.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
 }
 
   x__xgafv: string, V1 error format.
@@ -601,7 +622,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -631,7 +652,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -640,8 +661,8 @@ 
Method Details

   
Deletes a node pool from a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to delete. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to delete. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
@@ -672,7 +693,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -702,7 +723,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -750,8 +771,8 @@ 
Method Details

   
Retrieves the requested node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, cluster, node pool id) of the node pool to get. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
@@ -788,10 +809,10 @@ 
Method Details

     },
   ],
   "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+    "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
       { # AcceleratorConfig represents a Hardware Accelerator request.
         "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+        "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
         "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
           "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
         },
@@ -814,7 +835,7 @@ 
Method Details

       "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
       "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
     },
-    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+    "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
     "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
       "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
       "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -826,7 +847,7 @@ 
Method Details

             "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
               "A String",
             ],
-            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+            "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
               "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
             },
           },
@@ -842,11 +863,11 @@ 
Method Details

     "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
     "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
     "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
       "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
     "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
       "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -866,7 +887,7 @@ 
Method Details

         "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
       },
     },
-    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+    "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
     "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
       "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
         "A String",
@@ -926,6 +947,26 @@ 
Method Details

         "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
         "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
       },
+      "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+        "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+      },
+      "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+        "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+        },
+        "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+          "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+        },
+        "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+        "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+          "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+        },
+        "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+          "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+          "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+        },
+      },
       "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
         "a_key": "A String",
       },
@@ -933,27 +974,27 @@ 
Method Details

       "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     },
     "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+      "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
     },
-    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+    "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
     "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
     "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
       "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
         "variant": "A String", # Logging variant deployed on nodes.
       },
     },
-    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+    "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
     "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
     "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
       "a_key": "A String",
     },
-    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+    "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+    "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+    "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
       "A String",
     ],
-    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-    "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+    "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+    "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
       "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
       "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
       "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -963,7 +1004,7 @@ 
Method Details

     "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
       "a_key": "A String",
     },
-    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+    "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
       "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
         "a_key": "A String",
       },
@@ -988,7 +1029,7 @@ 
Method Details

     "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
       "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
       "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+        { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
           "key": "A String", # Key for NodeAffinity.
           "operator": "A String", # Operator for NodeAffinity.
           "values": [ # Values for NodeAffinity.
@@ -1020,11 +1061,11 @@ 
Method Details

     },
   },
   "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-  "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-  "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+  "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+  "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
     "A String",
   ],
-  "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+  "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
     "A String",
   ],
   "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1040,6 +1081,7 @@ 
Method Details

   },
   "name": "A String", # The name of the node pool.
   "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+    "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
     "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
       { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
         "network": "A String", # Name of the VPC where the additional interface belongs
@@ -1075,7 +1117,7 @@ 
Method Details

   },
   "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
     "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-    "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+    "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
     "type": "A String", # The type of placement.
   },
   "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1114,7 +1156,7 @@ 
Method Details

     "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
     "strategy": "A String", # Update strategy of the node pool.
   },
-  "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+  "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
 }

 
 
@@ -1123,8 +1165,8 @@ 
Method Details

   
Lists the node pools for a cluster.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field. (required)
   clusterId: string, Deprecated. The name of the cluster. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project, location, cluster name) where the node pools will be listed. Specified in the format `projects/*/locations/*/clusters/*`.
   x__xgafv: string, V1 error format.
@@ -1162,10 +1204,10 @@ 
Method Details

         },
       ],
       "config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
-        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+        "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
           { # AcceleratorConfig represents a Hardware Accelerator request.
             "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+            "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
             "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
               "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
             },
@@ -1188,7 +1230,7 @@ 
Method Details

           "provisionedThroughput": "A String", # For Hyperdisk-Balanced only, the provisioned throughput config value.
           "sizeGb": "A String", # Disk size in GB. Replaces NodeConfig.disk_size_gb
         },
-        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
+        "bootDiskKmsKey": "A String", #  The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
         "confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
           "confidentialInstanceType": "A String", # Defines the type of technology used by the confidential node.
           "enabled": True or False, # Whether Confidential Nodes feature is enabled.
@@ -1200,7 +1242,7 @@ 
Method Details

                 "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
                   "A String",
                 ],
-                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+                "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
                   "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
                 },
               },
@@ -1216,11 +1258,11 @@ 
Method Details

         "effectiveCgroupMode": "A String", # Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
         "enableConfidentialStorage": True or False, # Optional. Reserved for future use.
         "ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "ephemeralStorageLocalSsdConfig": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
           "dataCacheCount": 42, # Number of local SSDs to use for GKE Data Cache.
-          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
         "fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
           "enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
@@ -1240,7 +1282,7 @@ 
Method Details

             "nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
           },
         },
-        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+        "imageType": "A String", # The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
         "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
           "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
             "A String",
@@ -1300,6 +1342,26 @@ 
Method Details

             "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
             "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
           },
+          "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+            "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+          },
+          "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+            "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+            },
+            "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+              "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+            },
+            "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+            "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+              "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+            },
+            "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+              "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+              "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+            },
+          },
           "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
             "a_key": "A String",
           },
@@ -1307,27 +1369,27 @@ 
Method Details

           "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
         },
         "localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
-          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
+          "localSsdCount": 42, # Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
         },
-        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
+        "localSsdCount": 42, # The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
         "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attached to the node.
         "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
           "variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
             "variant": "A String", # Logging variant deployed on nodes.
           },
         },
-        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
+        "machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
         "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
         "metadata": { # The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp `[a-zA-Z0-9-_]+` and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-oslogin" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
           "a_key": "A String",
         },
-        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).
-        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).
-        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
+        "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: "Intel Haswell"` or `minCpuPlatform: "Intel Sandy Bridge"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
+        "nodeGroup": "A String", # Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
+        "oauthScopes": [ # The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
           "A String",
         ],
-        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
-        "reservationAffinity": { # [ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool.
+        "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
+        "reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
           "consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
           "key": "A String", # Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
           "values": [ # Corresponds to the label value(s) of reservation resource(s).
@@ -1337,7 +1399,7 @@ 
Method Details

         "resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
           "a_key": "A String",
         },
-        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
+        "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
           "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
             "a_key": "A String",
           },
@@ -1362,7 +1424,7 @@ 
Method Details

         "soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
           "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.
           "nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
-            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
+            { # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
               "key": "A String", # Key for NodeAffinity.
               "operator": "A String", # Operator for NodeAffinity.
               "values": [ # Values for NodeAffinity.
@@ -1394,11 +1456,11 @@ 
Method Details

         },
       },
       "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
-      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
-      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+      "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
+      "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
         "A String",
       ],
-      "locations": [ # The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
+      "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
         "A String",
       ],
       "management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
@@ -1414,6 +1476,7 @@ 
Method Details

       },
       "name": "A String", # The name of the node pool.
       "networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
+        "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
         "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
           { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
             "network": "A String", # Name of the VPC where the additional interface belongs
@@ -1449,7 +1512,7 @@ 
Method Details

       },
       "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
         "policyName": "A String", # If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.
-        "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies
+        "tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
         "type": "A String", # The type of placement.
       },
       "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
@@ -1488,7 +1551,7 @@ 
Method Details

         "maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
         "strategy": "A String", # Update strategy of the node pool.
       },
-      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).
+      "version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
     },
   ],
 }

@@ -1499,8 +1562,8 @@ 
Method Details

   
Rolls back a previously Aborted or Failed NodePool upgrade. This makes no changes if the last upgrade successfully completed.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1510,9 +1573,9 @@ 
Method Details

   "clusterId": "A String", # Deprecated. The name of the cluster to rollback. This field has been deprecated and replaced by the name field.
   "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to rollback upgrade. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "respectPdb": True or False, # Option for rollback to ignore the PodDisruptionBudget. Default value is false.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1542,7 +1605,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1572,7 +1635,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1581,8 +1644,8 @@ 
Method Details

   
Sets the NodeManagement options for a node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1600,8 +1663,8 @@ 
Method Details

   },
   "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1631,7 +1694,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1661,7 +1724,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1670,8 +1733,8 @@ 
Method Details

   
SetNodePoolSizeRequest sets the size of a node pool. The new size will be used for all replicas, including future replicas created by modifying NodePool.locations.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
@@ -1682,8 +1745,8 @@ 
Method Details

   "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set size. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodeCount": 42, # Required. The desired node count for the pool.
   "nodePoolId": "A String", # Deprecated. The name of the node pool to update. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -1713,7 +1776,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -1743,7 +1806,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -1752,18 +1815,18 @@ 
Method Details

   
Updates the version and/or image type of a specific node pool.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   clusterId: string, Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
   nodePoolId: string, Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # SetNodePoolVersionRequest updates the version of a node pool.
-  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
+  "accelerators": [ # A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
     { # AcceleratorConfig represents a Hardware Accelerator request.
       "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
-      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)
+      "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
       "gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
         "gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
       },
@@ -1793,7 +1856,7 @@ 
Method Details

           "fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
             "A String",
           ],
-          "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager). # Secret Manager certificate configuration.
+          "gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager). # Secret Manager certificate configuration.
             "secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
           },
         },
@@ -1817,7 +1880,7 @@ 
Method Details

   "gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
     "enabled": True or False, # Whether gVNIC features are enabled in the node pool.
   },
-  "imageType": "A String", # Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
+  "imageType": "A String", # Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
   "kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
     "allowedUnsafeSysctls": [ # Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in `*`). The unsafe namespaced sysctl groups are `kernel.shm*`, `kernel.msg*`, `kernel.sem`, `fs.mqueue.*`, and `net.*`. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: `kernel.msg*,net.ipv4.route.min_pmtu`. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
       "A String",
@@ -1879,13 +1942,33 @@ 
Method Details

       "hugepageSize1g": 42, # Optional. Amount of 1G hugepages
       "hugepageSize2m": 42, # Optional. Amount of 2M hugepages
     },
+    "nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
+      "policy": "A String", # Set the node module loading policy for nodes in the node pool.
+    },
+    "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled.
+      "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk.
+        "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+        "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the boot disk size.
+      },
+      "dedicatedLocalSsdProfile": { # Provisions a new, separate local NVMe SSD exclusively for swap. # Provisions a new, separate local NVMe SSD exclusively for swap.
+        "diskCount": "A String", # The number of physical local NVMe SSD disks to attach.
+      },
+      "enabled": True or False, # Optional. Enables or disables swap for the node pool.
+      "encryptionConfig": { # Defines encryption settings for the swap space. # Optional. If omitted, swap space is encrypted by default.
+        "disabled": True or False, # Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).
+      },
+      "ephemeralLocalSsdProfile": { # Swap on the local SSD shared with pod ephemeral storage. # Swap on the local SSD shared with pod ephemeral storage.
+        "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB).
+        "swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.
+      },
+    },
     "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_max_orphans net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes
       "a_key": "A String",
     },
     "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
     "transparentHugepageEnabled": "A String", # Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
   },
-  "locations": [ # The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.
+  "locations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.
     "A String",
   ],
   "loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
@@ -1897,6 +1980,7 @@ 
Method Details

   "maxRunDuration": "A String", # The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
   "name": "A String", # The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.
   "nodeNetworkConfig": { # Parameters for node pool-level network config. # Node network config.
+    "acceleratorNetworkProfile": "A String", # Immutable. The accelerator network profile for the node pool. For now the only valid value is "auto". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.
     "additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
       { # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
         "network": "A String", # Name of the VPC where the additional interface belongs
@@ -1932,16 +2016,16 @@ 
Method Details

   },
   "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field.
   "nodeVersion": "A String", # Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
   "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
     "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
   },
-  "resourceLabels": { # Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
+  "resourceLabels": { # Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels). # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
     "labels": { # Map of node label keys and node label values.
       "a_key": "A String",
     },
   },
-  "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
+  "resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values.
     "tags": { # Tags must be in one of the following formats ([KEY]=[VALUE]) 1. `tagKeys/{tag_key_id}=tagValues/{tag_value_id}` 2. `{org_id}/{tag_key_name}={tag_value_name}` 3. `{project_id}/{tag_key_name}={tag_value_name}`
       "a_key": "A String",
     },
@@ -1986,7 +2070,7 @@ 
Method Details

     "mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
     "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
   },
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -2016,7 +2100,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -2046,7 +2130,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
diff --git a/docs/dyn/container_v1beta1.projects.zones.html b/docs/dyn/container_v1beta1.projects.zones.html
index 0df3a3569a..d0ff99b849 100644
--- a/docs/dyn/container_v1beta1.projects.zones.html
+++ b/docs/dyn/container_v1beta1.projects.zones.html
@@ -101,8 +101,8 @@ 
Method Details

   
Returns configuration info about the Google Kubernetes Engine service.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project and location) of the server config to get, specified in the format `projects/*/locations/*`.
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html
index 69cf14907a..24e31f93af 100644
--- a/docs/dyn/container_v1beta1.projects.zones.operations.html
+++ b/docs/dyn/container_v1beta1.projects.zones.operations.html
@@ -92,8 +92,8 @@ 
Method Details

   
Cancels the specified operation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field. (required)
   operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   body: object, The request body.
     The object takes the form of:
@@ -101,8 +101,8 @@ 
Method Details

 { # CancelOperationRequest cancels a single operation.
   "name": "A String", # The name (project, location, operation id) of the operation to cancel. Specified in the format `projects/*/locations/*/operations/*`.
   "operationId": "A String", # Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field.
-  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
-  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
+  "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
+  "zone": "A String", # Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.
 }
 
   x__xgafv: string, V1 error format.
@@ -127,8 +127,8 @@ 
Method Details

   
Gets the specified operation.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
   operationId: string, Deprecated. The server-assigned `name` of the operation. This field has been deprecated and replaced by the name field. (required)
   name: string, The name (project, location, operation id) of the operation to get. Specified in the format `projects/*/locations/*/operations/*`.
   x__xgafv: string, V1 error format.
@@ -158,7 +158,7 @@ 
Method Details

     ],
     "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
   },
-  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
   "name": "A String", # Output only. The server-assigned ID for the operation.
   "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
     { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -188,7 +188,7 @@ 
Method Details

   "status": "A String", # Output only. The current status of the operation.
   "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
   "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
 }

 
 
@@ -197,8 +197,8 @@ 
Method Details

   
Lists all operations in a project in the specified zone or all zones.
 
 Args:
-  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
-  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
+  projectId: string, Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
+  zone: string, Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field. (required)
   parent: string, The parent (project and location) where the operations will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -232,7 +232,7 @@ 
Method Details

         ],
         "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
       },
-      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+      "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
       "name": "A String", # Output only. The server-assigned ID for the operation.
       "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
         { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
@@ -262,7 +262,7 @@ 
Method Details

       "status": "A String", # Output only. The current status of the operation.
       "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
       "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
-      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+      "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
     },
   ],
 }

diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json
index 4e3da818a5..497c49d2ed 100644
--- a/googleapiclient/discovery_cache/documents/container.v1.json
+++ b/googleapiclient/discovery_cache/documents/container.v1.json
@@ -176,13 +176,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -253,7 +253,7 @@
 ]
 },
 "create": {
-"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
+"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters",
 "httpMethod": "POST",
 "id": "container.projects.locations.clusters.create",
@@ -304,13 +304,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -377,13 +377,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -436,13 +436,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 }
@@ -513,7 +513,7 @@
 },
 "setLocations": {
 "deprecated": true,
-"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.",
+"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
 "httpMethod": "POST",
 "id": "container.projects.locations.clusters.setLocations",
@@ -882,13 +882,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -961,13 +961,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -1004,13 +1004,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 }
@@ -1247,13 +1247,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -1284,13 +1284,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 }
@@ -1325,13 +1325,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1367,13 +1367,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1408,13 +1408,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1432,7 +1432,7 @@
 ]
 },
 "create": {
-"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
+"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
 "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters",
 "httpMethod": "POST",
 "id": "container.projects.zones.clusters.create",
@@ -1442,13 +1442,13 @@
 ],
 "parameters": {
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1488,13 +1488,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1561,13 +1561,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1599,13 +1599,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1638,13 +1638,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1660,7 +1660,7 @@
 },
 "locations": {
 "deprecated": true,
-"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.",
+"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead.",
 "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
 "httpMethod": "POST",
 "id": "container.projects.zones.clusters.locations",
@@ -1677,13 +1677,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1718,13 +1718,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1759,13 +1759,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1800,13 +1800,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1841,13 +1841,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1882,13 +1882,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).",
+"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.",
+"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1923,13 +1923,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1964,13 +1964,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2005,13 +2005,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2046,13 +2046,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2098,13 +2098,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2139,13 +2139,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2192,13 +2192,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2272,13 +2272,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2315,13 +2315,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2360,13 +2360,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2408,13 +2408,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2456,13 +2456,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2504,13 +2504,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2551,13 +2551,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2597,13 +2597,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2633,13 +2633,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2660,7 +2660,7 @@
 }
 }
 },
-"revision": "20250930",
+"revision": "20251021",
 "rootUrl": "https://container.googleapis.com/",
 "schemas": {
 "AcceleratorConfig": {
@@ -2673,7 +2673,7 @@
 "type": "string"
 },
 "acceleratorType": {
-"description": "The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)",
+"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)",
 "type": "string"
 },
 "gpuDriverInstallationConfig": {
@@ -2816,7 +2816,7 @@
 "kubernetesDashboard": {
 "$ref": "KubernetesDashboard",
 "deprecated": true,
-"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards"
+"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards"
 },
 "lustreCsiDriverConfig": {
 "$ref": "LustreCsiDriverConfig",
@@ -3071,7 +3071,7 @@
 "id": "AutoprovisioningNodePoolDefaults",
 "properties": {
 "bootDiskKmsKey": {
-"description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption",
+"description": "The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption",
 "type": "string"
 },
 "diskSizeGb": {
@@ -3084,7 +3084,7 @@
 "type": "string"
 },
 "imageType": {
-"description": "The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.",
+"description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
 "type": "string"
 },
 "insecureKubeletReadonlyPortEnabled": {
@@ -3097,7 +3097,7 @@
 },
 "minCpuPlatform": {
 "deprecated": true,
-"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.",
+"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.",
 "type": "string"
 },
 "oauthScopes": {
@@ -3301,12 +3301,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -3480,7 +3480,7 @@
 },
 "currentNodeVersion": {
 "deprecated": true,
-"description": "Output only. Deprecated, use [NodePools.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.",
+"description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.",
 "readOnly": true,
 "type": "string"
 },
@@ -3551,7 +3551,7 @@
 },
 "initialNodeCount": {
 "deprecated": true,
-"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.",
+"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.",
 "format": "int32",
 "type": "integer"
 },
@@ -3577,12 +3577,12 @@
 "description": "Configuration for the legacy ABAC authorization mode."
 },
 "location": {
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
 "readOnly": true,
 "type": "string"
 },
 "locations": {
-"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.",
+"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.",
 "items": {
 "type": "string"
 },
@@ -3626,7 +3626,7 @@
 "type": "string"
 },
 "network": {
-"description": "The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.",
+"description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used.",
 "type": "string"
 },
 "networkConfig": {
@@ -3760,7 +3760,7 @@
 "type": "string"
 },
 "subnetwork": {
-"description": "The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected.",
+"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.",
 "type": "string"
 },
 "tpuIpv4CidrBlock": {
@@ -3783,7 +3783,7 @@
 },
 "zone": {
 "deprecated": true,
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.",
 "readOnly": true,
 "type": "string"
 }
@@ -3795,7 +3795,7 @@
 "id": "ClusterAutoscaling",
 "properties": {
 "autoprovisioningLocations": {
-"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.",
+"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.",
 "items": {
 "type": "string"
 },
@@ -3926,7 +3926,7 @@
 "enumDescriptions": [
 "Default value.",
 "Use the IPTables implementation based on kube-proxy.",
-"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more."
+"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more."
 ],
 "type": "string"
 },
@@ -4015,7 +4015,7 @@
 "description": "The desired L4 Internal Load Balancer Subsetting configuration."
 },
 "desiredLocations": {
-"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.",
+"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.",
 "items": {
 "type": "string"
 },
@@ -4294,12 +4294,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -4446,7 +4446,7 @@
 "properties": {
 "cluster": {
 "$ref": "Cluster",
-"description": "Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1/projects.locations.clusters)"
+"description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1/projects.locations.clusters)"
 },
 "parent": {
 "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.",
@@ -4454,12 +4454,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "type": "string"
 }
 },
@@ -4484,12 +4484,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "type": "string"
 }
 },
@@ -4766,7 +4766,7 @@
 "type": "integer"
 },
 "localSsdCount": {
-"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
+"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
 "format": "int32",
 "type": "integer"
 }
@@ -4939,7 +4939,7 @@
 "type": "object"
 },
 "GCPSecretManagerCertificateConfig": {
-"description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager).",
+"description": "GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager).",
 "id": "GCPSecretManagerCertificateConfig",
 "properties": {
 "secretUri": {
@@ -5546,6 +5546,10 @@ false
 "$ref": "HugepagesConfig",
 "description": "Optional. Amounts for 2M and 1G hugepages"
 },
+"nodeKernelModuleLoading": {
+"$ref": "NodeKernelModuleLoading",
+"description": "Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification."
+},
 "sysctls": {
 "additionalProperties": {
 "type": "string"
@@ -5671,7 +5675,7 @@ false
 "id": "LocalNvmeSsdBlockConfig",
 "properties": {
 "localSsdCount": {
-"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
+"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
 "format": "int32",
 "type": "integer"
 }
@@ -5766,6 +5770,18 @@ false
 "description": "Represents the Maintenance exclusion option.",
 "id": "MaintenanceExclusionOptions",
 "properties": {
+"endTimeBehavior": {
+"description": "EndTimeBehavior specifies the behavior of the exclusion end time.",
+"enum": [
+"END_TIME_BEHAVIOR_UNSPECIFIED",
+"UNTIL_END_OF_SUPPORT"
+],
+"enumDescriptions": [
+"END_TIME_BEHAVIOR_UNSPECIFIED is the default behavior, which is fixed end time.",
+"UNTIL_END_OF_SUPPORT means the exclusion will be in effect until the end of the support of the cluster's current version."
+],
+"type": "string"
+},
 "scope": {
 "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.",
 "enum": [
@@ -5860,12 +5876,12 @@ false
 },
 "password": {
 "deprecated": true,
-"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication",
+"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
 "type": "string"
 },
 "username": {
 "deprecated": true,
-"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication",
+"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
 "type": "string"
 }
 },
@@ -6037,7 +6053,7 @@ false
 "enumDescriptions": [
 "Default value.",
 "Use the IPTables implementation based on kube-proxy.",
-"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more."
+"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more."
 ],
 "type": "string"
 },
@@ -6096,7 +6112,7 @@ false
 "type": "string"
 },
 "network": {
-"description": "Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network",
+"description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network",
 "readOnly": true,
 "type": "string"
 },
@@ -6125,7 +6141,7 @@ false
 "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not."
 },
 "subnetwork": {
-"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet",
+"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet",
 "readOnly": true,
 "type": "string"
 }
@@ -6223,7 +6239,7 @@ false
 "type": "object"
 },
 "NodeAffinity": {
-"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).",
+"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).",
 "id": "NodeAffinity",
 "properties": {
 "key": {
@@ -6259,7 +6275,7 @@ false
 "id": "NodeConfig",
 "properties": {
 "accelerators": {
-"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.",
+"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.",
 "items": {
 "$ref": "AcceleratorConfig"
 },
@@ -6274,7 +6290,7 @@ false
 "description": "The boot disk configuration for the node pool."
 },
 "bootDiskKmsKey": {
-"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption",
+"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption",
 "type": "string"
 },
 "confidentialNodes": {
@@ -6334,7 +6350,7 @@ false
 "description": "Enable or disable gvnic in the node pool."
 },
 "imageType": {
-"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.",
+"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
 "type": "string"
 },
 "kubeletConfig": {
@@ -6357,7 +6373,7 @@ false
 "description": "Parameters for using raw-block Local NVMe SSDs."
 },
 "localSsdCount": {
-"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.",
+"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.",
 "format": "int32",
 "type": "integer"
 },
@@ -6380,7 +6396,7 @@ false
 "description": "Logging configuration."
 },
 "machineType": {
-"description": "The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.",
+"description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types) If unspecified, the default machine type is `e2-medium`.",
 "type": "string"
 },
 "maxRunDuration": {
@@ -6396,27 +6412,27 @@ false
 "type": "object"
 },
 "minCpuPlatform": {
-"description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform)",
+"description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)",
 "type": "string"
 },
 "nodeGroup": {
-"description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).",
+"description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).",
 "type": "string"
 },
 "oauthScopes": {
-"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
+"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "preemptible": {
-"description": "Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.",
+"description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.",
 "type": "boolean"
 },
 "reservationAffinity": {
 "$ref": "ReservationAffinity",
-"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool."
+"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool."
 },
 "resourceLabels": {
 "additionalProperties": {
@@ -6515,6 +6531,27 @@ false
 },
 "type": "object"
 },
+"NodeKernelModuleLoading": {
+"description": "Configuration for kernel module loading on nodes.",
+"id": "NodeKernelModuleLoading",
+"properties": {
+"policy": {
+"description": "Set the node module loading policy for nodes in the node pool.",
+"enum": [
+"POLICY_UNSPECIFIED",
+"ENFORCE_SIGNED_MODULES",
+"DO_NOT_ENFORCE_SIGNED_MODULES"
+],
+"enumDescriptions": [
+"Default behavior. GKE selects the image based on node type. For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not.",
+"Enforced signature verification: Node pools will use a Container-Optimized OS image configured to allow loading of *Google-signed* external kernel modules. Loadpin is enabled but configured to exclude modules, and kernel module signature checking is enforced.",
+"Mirrors existing DEFAULT behavior: For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "NodeKubeletConfig": {
 "description": "Node kubelet configs.",
 "id": "NodeKubeletConfig",
@@ -6737,12 +6774,12 @@ false
 "type": "string"
 },
 "initialNodeCount": {
-"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
+"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
 "format": "int32",
 "type": "integer"
 },
 "instanceGroupUrls": {
-"description": "Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.",
+"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.",
 "items": {
 "type": "string"
 },
@@ -6750,7 +6787,7 @@ false
 "type": "array"
 },
 "locations": {
-"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.",
+"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.",
 "items": {
 "type": "string"
 },
@@ -6830,7 +6867,7 @@ false
 "description": "Upgrade settings control disruption and speed of the upgrade."
 },
 "version": {
-"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).",
+"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).",
 "type": "string"
 }
 },
@@ -7084,7 +7121,7 @@ false
 "description": "The error result of the operation in case of failure."
 },
 "location": {
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
 "readOnly": true,
 "type": "string"
 },
@@ -7149,21 +7186,21 @@ false
 "Not set.",
 "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.",
 "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.",
-"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).",
-"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.",
-"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
-"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.",
-"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.",
+"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).",
+"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.",
+"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
+"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.",
+"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.",
 "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.",
 "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.",
-"A problem has been detected with nodes and [they are being repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.",
+"A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.",
 "Unused. Automatic node upgrade uses UPGRADE_NODES.",
 "Unused. Updating labels uses UPDATE_CLUSTER.",
 "Unused. Updating master auth uses UPDATE_CLUSTER.",
 "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.",
 "Unused. Updating network policy uses UPDATE_CLUSTER.",
 "Unused. Updating maintenance policy uses UPDATE_CLUSTER.",
-"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
+"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
 "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes."
 ],
 "readOnly": true,
@@ -7216,7 +7253,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.",
 "readOnly": true,
 "type": "string"
 }
@@ -7324,7 +7361,7 @@ false
 "type": "string"
 },
 "tpuTopology": {
-"description": "Optional. TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies",
+"description": "Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies",
 "type": "string"
 },
 "type": {
@@ -7650,7 +7687,7 @@ false
 "type": "object"
 },
 "ReservationAffinity": {
-"description": "[ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.",
+"description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.",
 "id": "ReservationAffinity",
 "properties": {
 "consumeReservationType": {
@@ -7684,7 +7721,7 @@ false
 "type": "object"
 },
 "ResourceLabels": {
-"description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).",
+"description": "Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).",
 "id": "ResourceLabels",
 "properties": {
 "labels": {
@@ -7719,7 +7756,7 @@ false
 "type": "object"
 },
 "ResourceManagerTags": {
-"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.",
+"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.",
 "id": "ResourceManagerTags",
 "properties": {
 "tags": {
@@ -7771,7 +7808,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "respectPdb": {
@@ -7780,7 +7817,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8040,12 +8077,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8070,7 +8107,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "resourceLabels": {
@@ -8082,7 +8119,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8107,12 +8144,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8128,7 +8165,7 @@ false
 "type": "string"
 },
 "locations": {
-"description": "Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.",
+"description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.",
 "items": {
 "type": "string"
 },
@@ -8140,12 +8177,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8170,12 +8207,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8198,11 +8235,11 @@ false
 "type": "string"
 },
 "projectId": {
-"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).",
+"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).",
 "type": "string"
 },
 "zone": {
-"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.",
+"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.",
 "type": "string"
 }
 },
@@ -8239,7 +8276,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "update": {
@@ -8248,7 +8285,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8273,12 +8310,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8303,12 +8340,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8338,12 +8375,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8373,12 +8410,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8409,12 +8446,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8502,7 +8539,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "rotateCredentials": {
@@ -8511,7 +8548,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8686,7 +8723,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "update": {
@@ -8695,7 +8732,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8731,12 +8768,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8747,7 +8784,7 @@ false
 "id": "UpdateNodePoolRequest",
 "properties": {
 "accelerators": {
-"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.",
+"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.",
 "items": {
 "$ref": "AcceleratorConfig"
 },
@@ -8800,7 +8837,7 @@ false
 "description": "Enable or disable gvnic on the node pool."
 },
 "imageType": {
-"description": "Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.",
+"description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
 "type": "string"
 },
 "kubeletConfig": {
@@ -8816,7 +8853,7 @@ false
 "description": "Parameters that can be configured on Linux nodes."
 },
 "locations": {
-"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.",
+"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.",
 "items": {
 "type": "string"
 },
@@ -8827,7 +8864,7 @@ false
 "description": "Logging configuration."
 },
 "machineType": {
-"description": "Optional. The desired [Google Compute Engine machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.",
+"description": "Optional. The desired [Google Compute Engine machine type](https://cloud.google.com/compute/docs/machine-types) for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type.",
 "type": "string"
 },
 "maxRunDuration": {
@@ -8854,7 +8891,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "queuedProvisioning": {
@@ -8898,7 +8935,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json
index f013be7f6a..b5956cfe76 100644
--- a/googleapiclient/discovery_cache/documents/container.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json
@@ -176,13 +176,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -278,7 +278,7 @@
 ]
 },
 "create": {
-"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
+"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters",
 "httpMethod": "POST",
 "id": "container.projects.locations.clusters.create",
@@ -329,13 +329,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -402,13 +402,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -461,13 +461,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 }
@@ -538,7 +538,7 @@
 },
 "setLocations": {
 "deprecated": true,
-"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.",
+"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations",
 "httpMethod": "POST",
 "id": "container.projects.locations.clusters.setLocations",
@@ -907,13 +907,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -986,13 +986,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -1029,13 +1029,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 }
@@ -1272,13 +1272,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "query",
 "type": "string"
 }
@@ -1309,13 +1309,13 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "query",
 "type": "string"
 }
@@ -1350,13 +1350,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1392,13 +1392,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1433,13 +1433,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1457,7 +1457,7 @@
 ]
 },
 "create": {
-"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
+"description": "Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.",
 "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters",
 "httpMethod": "POST",
 "id": "container.projects.zones.clusters.create",
@@ -1467,13 +1467,13 @@
 ],
 "parameters": {
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1513,13 +1513,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1586,13 +1586,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1624,13 +1624,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1663,13 +1663,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or \"-\" for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1685,7 +1685,7 @@
 },
 "locations": {
 "deprecated": true,
-"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.",
+"description": "Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.",
 "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations",
 "httpMethod": "POST",
 "id": "container.projects.zones.clusters.locations",
@@ -1702,13 +1702,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1743,13 +1743,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1784,13 +1784,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1825,13 +1825,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1866,13 +1866,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1907,13 +1907,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).",
+"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.",
+"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1948,13 +1948,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1989,13 +1989,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2030,13 +2030,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2071,13 +2071,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2123,13 +2123,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2164,13 +2164,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2217,13 +2217,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2297,13 +2297,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2340,13 +2340,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2385,13 +2385,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2433,13 +2433,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2481,13 +2481,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2529,13 +2529,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2576,13 +2576,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2622,13 +2622,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2658,13 +2658,13 @@
 "type": "string"
 },
 "projectId": {
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "zone": {
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) to return operations for, or `-` for all zones. This field has been deprecated and replaced by the parent field.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2685,7 +2685,7 @@
 }
 }
 },
-"revision": "20250930",
+"revision": "20251021",
 "rootUrl": "https://container.googleapis.com/",
 "schemas": {
 "AcceleratorConfig": {
@@ -2698,7 +2698,7 @@
 "type": "string"
 },
 "acceleratorType": {
-"description": "The accelerator type resource name. List of supported accelerators [here](https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus)",
+"description": "The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)",
 "type": "string"
 },
 "gpuDriverInstallationConfig": {
@@ -2857,7 +2857,7 @@
 "kubernetesDashboard": {
 "$ref": "KubernetesDashboard",
 "deprecated": true,
-"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/dashboards"
+"description": "Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards"
 },
 "lustreCsiDriverConfig": {
 "$ref": "LustreCsiDriverConfig",
@@ -3137,7 +3137,7 @@
 "id": "AutoprovisioningNodePoolDefaults",
 "properties": {
 "bootDiskKmsKey": {
-"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption",
+"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption",
 "type": "string"
 },
 "diskSizeGb": {
@@ -3150,7 +3150,7 @@
 "type": "string"
 },
 "imageType": {
-"description": "The image type to use for NAP created node. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.",
+"description": "The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
 "type": "string"
 },
 "insecureKubeletReadonlyPortEnabled": {
@@ -3163,11 +3163,11 @@
 },
 "minCpuPlatform": {
 "deprecated": true,
-"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.",
+"description": "Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass \"automatic\" as field value.",
 "type": "string"
 },
 "oauthScopes": {
-"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
+"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
 "items": {
 "type": "string"
 },
@@ -3381,6 +3381,23 @@
 },
 "type": "object"
 },
+"BootDiskProfile": {
+"description": "Swap on the node's boot disk.",
+"id": "BootDiskProfile",
+"properties": {
+"swapSizeGib": {
+"description": "Specifies the size of the swap space in gibibytes (GiB).",
+"format": "int64",
+"type": "string"
+},
+"swapSizePercent": {
+"description": "Specifies the size of the swap space as a percentage of the boot disk size.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "CancelOperationRequest": {
 "description": "CancelOperationRequest cancels a single operation.",
 "id": "CancelOperationRequest",
@@ -3396,12 +3413,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -3579,7 +3596,7 @@
 },
 "currentNodeVersion": {
 "deprecated": true,
-"description": "Output only. Deprecated, use [NodePool.version](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.",
+"description": "Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.",
 "readOnly": true,
 "type": "string"
 },
@@ -3650,7 +3667,7 @@
 },
 "initialNodeCount": {
 "deprecated": true,
-"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.",
+"description": "The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"node_config\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.",
 "format": "int32",
 "type": "integer"
 },
@@ -3676,12 +3693,12 @@
 "description": "Configuration for the legacy ABAC authorization mode."
 },
 "location": {
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
 "readOnly": true,
 "type": "string"
 },
 "locations": {
-"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.",
+"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.",
 "items": {
 "type": "string"
 },
@@ -3734,7 +3751,7 @@
 "type": "string"
 },
 "network": {
-"description": "The name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.",
+"description": "The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.",
 "type": "string"
 },
 "networkConfig": {
@@ -3886,7 +3903,7 @@
 "type": "string"
 },
 "subnetwork": {
-"description": "The name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.",
+"description": "The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.",
 "type": "string"
 },
 "tpuConfig": {
@@ -3922,7 +3939,7 @@
 },
 "zone": {
 "deprecated": true,
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.",
 "readOnly": true,
 "type": "string"
 }
@@ -3934,7 +3951,7 @@
 "id": "ClusterAutoscaling",
 "properties": {
 "autoprovisioningLocations": {
-"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.",
+"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.",
 "items": {
 "type": "string"
 },
@@ -4092,7 +4109,7 @@
 "enumDescriptions": [
 "Default value.",
 "Use the IPTables implementation based on kube-proxy.",
-"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more."
+"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more."
 ],
 "type": "string"
 },
@@ -4185,7 +4202,7 @@
 "description": "The desired L4 Internal Load Balancer Subsetting configuration."
 },
 "desiredLocations": {
-"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.",
+"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.",
 "items": {
 "type": "string"
 },
@@ -4326,6 +4343,10 @@
 "$ref": "SecretManagerConfig",
 "description": "Enable/Disable Secret Manager Config."
 },
+"desiredSecretSyncConfig": {
+"$ref": "SecretSyncConfig",
+"description": "Configuration for sync Secret Manager secrets as k8s secrets."
+},
 "desiredSecurityPostureConfig": {
 "$ref": "SecurityPostureConfig",
 "description": "Enable/Disable Security Posture API features for the cluster."
@@ -4495,12 +4516,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -4647,7 +4668,7 @@
 "properties": {
 "cluster": {
 "$ref": "Cluster",
-"description": "Required. A [cluster resource](https://{$universe.dns_names.final_documentation_domain}/container-engine/reference/rest/v1beta1/projects.locations.clusters)"
+"description": "Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)"
 },
 "parent": {
 "description": "The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.",
@@ -4655,12 +4676,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "type": "string"
 }
 },
@@ -4685,12 +4706,12 @@
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.",
 "type": "string"
 }
 },
@@ -4867,6 +4888,18 @@
 },
 "type": "object"
 },
+"DedicatedLocalSsdProfile": {
+"description": "Provisions a new, separate local NVMe SSD exclusively for swap.",
+"id": "DedicatedLocalSsdProfile",
+"properties": {
+"diskCount": {
+"description": "The number of physical local NVMe SSD disks to attach.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "DefaultComputeClassConfig": {
 "description": "DefaultComputeClassConfig defines default compute class configuration.",
 "id": "DefaultComputeClassConfig",
@@ -4942,6 +4975,17 @@
 "properties": {},
 "type": "object"
 },
+"EncryptionConfig": {
+"description": "Defines encryption settings for the swap space.",
+"id": "EncryptionConfig",
+"properties": {
+"disabled": {
+"description": "Optional. If true, swap space will not be encrypted. Defaults to false (encrypted).",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "EnterpriseConfig": {
 "deprecated": true,
 "description": "EnterpriseConfig is the cluster enterprise configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier.",
@@ -4979,12 +5023,29 @@
 },
 "type": "object"
 },
+"EphemeralLocalSsdProfile": {
+"description": "Swap on the local SSD shared with pod ephemeral storage.",
+"id": "EphemeralLocalSsdProfile",
+"properties": {
+"swapSizeGib": {
+"description": "Specifies the size of the swap space in gibibytes (GiB).",
+"format": "int64",
+"type": "string"
+},
+"swapSizePercent": {
+"description": "Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "EphemeralStorageConfig": {
 "description": "EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.",
 "id": "EphemeralStorageConfig",
 "properties": {
 "localSsdCount": {
-"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
+"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
 "format": "int32",
 "type": "integer"
 }
@@ -5001,7 +5062,7 @@
 "type": "integer"
 },
 "localSsdCount": {
-"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
+"description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
 "format": "int32",
 "type": "integer"
 }
@@ -5174,7 +5235,7 @@
 "type": "object"
 },
 "GCPSecretManagerCertificateConfig": {
-"description": "GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://{$universe.dns_names.final_documentation_domain}/secret-manager).",
+"description": "GCPSecretManagerCertificateConfig configures a secret from [Secret Manager](https://cloud.google.com/secret-manager).",
 "id": "GCPSecretManagerCertificateConfig",
 "properties": {
 "secretUri": {
@@ -5847,6 +5908,14 @@ false
 "$ref": "HugepagesConfig",
 "description": "Optional. Amounts for 2M and 1G hugepages"
 },
+"nodeKernelModuleLoading": {
+"$ref": "NodeKernelModuleLoading",
+"description": "Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification."
+},
+"swapConfig": {
+"$ref": "SwapConfig",
+"description": "Optional. Enables and configures swap space on nodes. If omitted, swap is disabled."
+},
 "sysctls": {
 "additionalProperties": {
 "type": "string"
@@ -5990,7 +6059,7 @@ false
 "id": "LocalNvmeSsdBlockConfig",
 "properties": {
 "localSsdCount": {
-"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
+"description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.",
 "format": "int32",
 "type": "integer"
 }
@@ -6114,6 +6183,18 @@ false
 "description": "Represents the Maintenance exclusion option.",
 "id": "MaintenanceExclusionOptions",
 "properties": {
+"endTimeBehavior": {
+"description": "EndTimeBehavior specifies the behavior of the exclusion end time.",
+"enum": [
+"END_TIME_BEHAVIOR_UNSPECIFIED",
+"UNTIL_END_OF_SUPPORT"
+],
+"enumDescriptions": [
+"END_TIME_BEHAVIOR_UNSPECIFIED is the default behavior, which is fixed end time.",
+"UNTIL_END_OF_SUPPORT means the exclusion will be in effect until the end of the support of the cluster's current version."
+],
+"type": "string"
+},
 "scope": {
 "description": "Scope specifies the upgrade scope which upgrades are blocked by the exclusion.",
 "enum": [
@@ -6214,12 +6295,12 @@ false
 },
 "password": {
 "deprecated": true,
-"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication",
+"description": "The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
 "type": "string"
 },
 "username": {
 "deprecated": true,
-"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/api-server-authentication",
+"description": "The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication",
 "type": "string"
 }
 },
@@ -6411,7 +6492,7 @@ false
 "enumDescriptions": [
 "Default value.",
 "Use the IPTables implementation based on kube-proxy.",
-"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/dataplane-v2) for more."
+"Use the eBPF based GKE Dataplane V2 with additional features. See the [GKE Dataplane V2 documentation](https://cloud.google.com/kubernetes-engine/docs/how-to/dataplane-v2) for more."
 ],
 "type": "string"
 },
@@ -6470,7 +6551,7 @@ false
 "type": "string"
 },
 "network": {
-"description": "Output only. The relative name of the Google Compute Engine [network](https://{$universe.dns_names.final_documentation_domain}/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network",
+"description": "Output only. The relative name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network",
 "readOnly": true,
 "type": "string"
 },
@@ -6499,7 +6580,7 @@ false
 "description": "ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not."
 },
 "subnetwork": {
-"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://{$universe.dns_names.final_documentation_domain}/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet",
+"description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet",
 "readOnly": true,
 "type": "string"
 }
@@ -6609,7 +6690,7 @@ false
 "type": "object"
 },
 "NodeAffinity": {
-"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).",
+"description": "Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).",
 "id": "NodeAffinity",
 "properties": {
 "key": {
@@ -6645,7 +6726,7 @@ false
 "id": "NodeConfig",
 "properties": {
 "accelerators": {
-"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.",
+"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.",
 "items": {
 "$ref": "AcceleratorConfig"
 },
@@ -6660,7 +6741,7 @@ false
 "description": "Boot disk configuration for the node pool."
 },
 "bootDiskKmsKey": {
-"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption",
+"description": " The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption",
 "type": "string"
 },
 "confidentialNodes": {
@@ -6728,7 +6809,7 @@ false
 "description": "HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts."
 },
 "imageType": {
-"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.",
+"description": "The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
 "type": "string"
 },
 "kubeletConfig": {
@@ -6751,7 +6832,7 @@ false
 "description": "Parameters for using raw-block Local NVMe SSDs."
 },
 "localSsdCount": {
-"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.",
+"description": "The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.",
 "format": "int32",
 "type": "integer"
 },
@@ -6774,7 +6855,7 @@ false
 "description": "Logging configuration."
 },
 "machineType": {
-"description": "The name of a Google Compute Engine [machine type](https://{$universe.dns_names.final_documentation_domain}/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.",
+"description": "The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.",
 "type": "string"
 },
 "maxRunDuration": {
@@ -6790,27 +6871,27 @@ false
 "type": "object"
 },
 "minCpuPlatform": {
-"description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/specify-min-cpu-platform).",
+"description": "Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: \"Intel Haswell\"` or `minCpuPlatform: \"Intel Sandy Bridge\"`. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).",
 "type": "string"
 },
 "nodeGroup": {
-"description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://{$universe.dns_names.final_documentation_domain}/compute/docs/nodes/sole-tenant-nodes).",
+"description": "Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on [sole tenant nodes](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).",
 "type": "string"
 },
 "oauthScopes": {
-"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Google Container Registry](https://{$universe.dns_names.final_documentation_domain}/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
+"description": "The set of Google API scopes to be made available on all of the node VMs under the \"default\" service account. The following scopes are recommended, but not required, and by default are not included: * `https://www.googleapis.com/auth/compute` is required for mounting persistent storage on your nodes. * `https://www.googleapis.com/auth/devstorage.read_only` is required for communicating with **gcr.io** (the [Artifact Registry](https://cloud.google.com/artifact-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "preemptible": {
-"description": "Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.",
+"description": "Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.",
 "type": "boolean"
 },
 "reservationAffinity": {
 "$ref": "ReservationAffinity",
-"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) to this node pool."
+"description": "The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool."
 },
 "resourceLabels": {
 "additionalProperties": {
@@ -6913,6 +6994,27 @@ false
 },
 "type": "object"
 },
+"NodeKernelModuleLoading": {
+"description": "Configuration for kernel module loading on nodes.",
+"id": "NodeKernelModuleLoading",
+"properties": {
+"policy": {
+"description": "Set the node module loading policy for nodes in the node pool.",
+"enum": [
+"POLICY_UNSPECIFIED",
+"ENFORCE_SIGNED_MODULES",
+"DO_NOT_ENFORCE_SIGNED_MODULES"
+],
+"enumDescriptions": [
+"Default behavior. GKE selects the image based on node type. For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not.",
+"Enforced signature verification: Node pools will use a Container-Optimized OS image configured to allow loading of *Google-signed* external kernel modules. Loadpin is enabled but configured to exclude modules, and kernel module signature checking is enforced.",
+"Mirrors existing DEFAULT behavior: For CPU and TPU nodes, the image will not allow loading external kernel modules. For GPU nodes, the image will allow loading any module, whether it is signed or not."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "NodeKubeletConfig": {
 "description": "Node kubelet configs.",
 "id": "NodeKubeletConfig",
@@ -7046,6 +7148,10 @@ false
 "description": "Parameters for node pool-level network config.",
 "id": "NodeNetworkConfig",
 "properties": {
+"acceleratorNetworkProfile": {
+"description": "Immutable. The accelerator network profile for the node pool. For now the only valid value is \"auto\". If specified, the network configuration of the nodes in this node pool will be managed by this profile for the supported machine types, zone, etc.",
+"type": "string"
+},
 "additionalNodeNetworkConfigs": {
 "description": "We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface",
 "items": {
@@ -7135,12 +7241,12 @@ false
 "type": "string"
 },
 "initialNodeCount": {
-"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://{$universe.dns_names.final_documentation_domain}/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
+"description": "The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.",
 "format": "int32",
 "type": "integer"
 },
 "instanceGroupUrls": {
-"description": "Output only. The resource URLs of the [managed instance groups](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.",
+"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.",
 "items": {
 "type": "string"
 },
@@ -7148,7 +7254,7 @@ false
 "type": "array"
 },
 "locations": {
-"description": "The list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.",
+"description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.",
 "items": {
 "type": "string"
 },
@@ -7228,7 +7334,7 @@ false
 "description": "Upgrade settings control disruption and speed of the upgrade."
 },
 "version": {
-"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/versioning#specifying_node_version).",
+"description": "The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).",
 "type": "string"
 }
 },
@@ -7482,7 +7588,7 @@ false
 "description": "The error result of the operation in case of failure."
 },
 "location": {
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) or [region](https://{$universe.dns_names.final_documentation_domain}/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.",
 "readOnly": true,
 "type": "string"
 },
@@ -7547,21 +7653,21 @@ false
 "Not set.",
 "The cluster is being created. The cluster should be assumed to be unusable until the operation finishes. In the event of the operation failing, the cluster will enter the ERROR state and eventually be deleted.",
 "The cluster is being deleted. The cluster should be assumed to be unusable as soon as this operation starts. In the event of the operation failing, the cluster will enter the ERROR state and the deletion will be automatically retried until completed.",
-"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).",
-"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.",
-"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
-"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.",
-"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.",
+"The cluster version is being updated. Note that this includes \"upgrades\" to the same version, which are simply a recreation. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#upgrading_automatically). For more details, see [documentation on cluster upgrades](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-upgrades#cluster_upgrades).",
+"A node pool is being updated. Despite calling this an \"upgrade\", this includes most forms of updates to node pools. This also includes [auto-upgrades](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-upgrades). This operation sets the progress field and may be canceled. The upgrade strategy depends on [node pool configuration](https://cloud.google.com/kubernetes-engine/docs/concepts/node-pool-upgrade-strategies). The nodes are generally still usable during this operation.",
+"A problem has been detected with the control plane and is being repaired. This operation type is initiated by GKE. For more details, see [documentation on repairs](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
+"The cluster is being updated. This is a broad category of operations and includes operations that only change metadata as well as those that must recreate the entire cluster. If the control plane must be recreated, this will cause temporary downtime for zonal clusters. Some features require recreating the nodes as well. Those will be recreated as separate operations and the update may not be completely functional until the node pools recreations finish. Node recreations will generally follow [maintenance policies](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions). Some GKE-initiated operations use this type. This includes certain types of auto-upgrades and incident mitigations.",
+"A node pool is being created. The node pool should be assumed to be unusable until this operation finishes. In the event of an error, the node pool may be partially created. If enabled, [node autoprovisioning](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-provisioning) may have automatically initiated such operations.",
 "The node pool is being deleted. The node pool should be assumed to be unusable as soon as this operation starts.",
 "The node pool's manamagent field is being updated. These operations only update metadata and may be concurrent with most other operations.",
-"A problem has been detected with nodes and [they are being repaired](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.",
+"A problem has been detected with nodes and [they are being repaired](https://cloud.google.com/kubernetes-engine/docs/how-to/node-auto-repair). This operation type is initiated by GKE, typically automatically. This operation may be concurrent with other operations and there may be multiple repairs occurring on the same node pool.",
 "Unused. Automatic node upgrade uses UPGRADE_NODES.",
 "Unused. Updating labels uses UPDATE_CLUSTER.",
 "Unused. Updating master auth uses UPDATE_CLUSTER.",
 "The node pool is being resized. With the exception of resizing to or from size zero, the node pool is generally usable during this operation.",
 "Unused. Updating network policy uses UPDATE_CLUSTER.",
 "Unused. Updating maintenance policy uses UPDATE_CLUSTER.",
-"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
+"The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).",
 "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes."
 ],
 "readOnly": true,
@@ -7614,7 +7720,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Output only. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.",
+"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.",
 "readOnly": true,
 "type": "string"
 }
@@ -7744,7 +7850,7 @@ false
 "type": "string"
 },
 "tpuTopology": {
-"description": "TPU placement topology for pod slice node pool. https://{$universe.dns_names.final_documentation_domain}/tpu/docs/types-topologies#tpu_topologies",
+"description": "TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies",
 "type": "string"
 },
 "type": {
@@ -8125,7 +8231,7 @@ false
 "type": "object"
 },
 "ReservationAffinity": {
-"description": "[ReservationAffinity](https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.",
+"description": "[ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from.",
 "id": "ReservationAffinity",
 "properties": {
 "consumeReservationType": {
@@ -8159,7 +8265,7 @@ false
 "type": "object"
 },
 "ResourceLabels": {
-"description": "Collection of [Resource Manager labels](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-labels).",
+"description": "Collection of [Resource Manager labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels).",
 "id": "ResourceLabels",
 "properties": {
 "labels": {
@@ -8194,7 +8300,7 @@ false
 "type": "object"
 },
 "ResourceManagerTags": {
-"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://{$universe.dns_names.final_documentation_domain}/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.",
+"description": "A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values.",
 "id": "ResourceManagerTags",
 "properties": {
 "tags": {
@@ -8246,7 +8352,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "respectPdb": {
@@ -8255,7 +8361,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8542,12 +8648,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8572,7 +8678,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "resourceLabels": {
@@ -8584,7 +8690,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8609,12 +8715,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8630,7 +8736,7 @@ false
 "type": "string"
 },
 "locations": {
-"description": "Required. The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.",
+"description": "Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.",
 "items": {
 "type": "string"
 },
@@ -8642,12 +8748,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8672,12 +8778,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8700,11 +8806,11 @@ false
 "type": "string"
 },
 "projectId": {
-"description": "Required. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects).",
+"description": "Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).",
 "type": "string"
 },
 "zone": {
-"description": "Required. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides.",
+"description": "Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.",
 "type": "string"
 }
 },
@@ -8741,7 +8847,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "update": {
@@ -8750,7 +8856,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8775,12 +8881,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8805,12 +8911,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8840,12 +8946,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8875,12 +8981,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -8911,12 +9017,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -9004,7 +9110,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "rotateCredentials": {
@@ -9013,7 +9119,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -9137,6 +9243,33 @@ false
 },
 "type": "object"
 },
+"SwapConfig": {
+"description": "Configuration for swap memory on a node pool.",
+"id": "SwapConfig",
+"properties": {
+"bootDiskProfile": {
+"$ref": "BootDiskProfile",
+"description": "Swap on the node's boot disk."
+},
+"dedicatedLocalSsdProfile": {
+"$ref": "DedicatedLocalSsdProfile",
+"description": "Provisions a new, separate local NVMe SSD exclusively for swap."
+},
+"enabled": {
+"description": "Optional. Enables or disables swap for the node pool.",
+"type": "boolean"
+},
+"encryptionConfig": {
+"$ref": "EncryptionConfig",
+"description": "Optional. If omitted, swap space is encrypted by default."
+},
+"ephemeralLocalSsdProfile": {
+"$ref": "EphemeralLocalSsdProfile",
+"description": "Swap on the local SSD shared with pod ephemeral storage."
+}
+},
+"type": "object"
+},
 "SyncRotationConfig": {
 "description": "SyncRotationConfig is config for secret manager auto rotation.",
 "id": "SyncRotationConfig",
@@ -9224,7 +9357,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "update": {
@@ -9233,7 +9366,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -9269,12 +9402,12 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -9285,7 +9418,7 @@ false
 "id": "UpdateNodePoolRequest",
 "properties": {
 "accelerators": {
-"description": "A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.",
+"description": "A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.",
 "items": {
 "$ref": "AcceleratorConfig"
 },
@@ -9338,7 +9471,7 @@ false
 "description": "Enable or disable gvnic on the node pool."
 },
 "imageType": {
-"description": "Required. The desired image type for the node pool. Please see https://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.",
+"description": "Required. The desired image type for the node pool. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.",
 "type": "string"
 },
 "kubeletConfig": {
@@ -9354,7 +9487,7 @@ false
 "description": "Parameters that can be configured on Linux nodes."
 },
 "locations": {
-"description": "The desired list of Google Compute Engine [zones](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed.",
+"description": "The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as `tags`, `labels`, `taints`, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes.",
 "items": {
 "type": "string"
 },
@@ -9392,7 +9525,7 @@ false
 },
 "projectId": {
 "deprecated": true,
-"description": "Deprecated. The Google Developers Console [project ID or project number](https://{$universe.dns_names.final_documentation_domain}/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.",
 "type": "string"
 },
 "queuedProvisioning": {
@@ -9436,7 +9569,7 @@ false
 },
 "zone": {
 "deprecated": true,
-"description": "Deprecated. The name of the Google Compute Engine [zone](https://{$universe.dns_names.final_documentation_domain}/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
+"description": "Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.",
 "type": "string"
 }
 },
@@ -9541,6 +9674,10 @@ false
 "description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.",
 "id": "UpgradeEvent",
 "properties": {
+"currentEmulatedVersion": {
+"description": "The current emulated version before the upgrade.",
+"type": "string"
+},
 "currentVersion": {
 "description": "The current version before the upgrade.",
 "type": "string"
@@ -9572,6 +9709,10 @@ false
 ],
 "type": "string"
 },
+"targetEmulatedVersion": {
+"description": "The target emulated version for the upgrade.",
+"type": "string"
+},
 "targetVersion": {
 "description": "The target version for the upgrade.",
 "type": "string"
@@ -9583,6 +9724,10 @@ false
 "description": "UpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource.",
 "id": "UpgradeInfoEvent",
 "properties": {
+"currentEmulatedVersion": {
+"description": "The current emulated version before the upgrade.",
+"type": "string"
+},
 "currentVersion": {
 "description": "The current version before the upgrade.",
 "type": "string"
@@ -9668,6 +9813,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"targetEmulatedVersion": {
+"description": "The target emulated version for the upgrade.",
+"type": "string"
+},
 "targetVersion": {
 "description": "The target version for the upgrade.",
 "type": "string"

From 522c3dfd8bffc400c6bd149d69a1dbe5e90cd01f Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 24/70] fix(dataflow): update the api

#### dataflow:v1b3

The following keys were changed:
- endpoints (Total Keys: 1)
---
 .../documents/dataflow.v1b3.json              | 77 ++++++++++++++++++-
 1 file changed, 76 insertions(+), 1 deletion(-)

diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
index eb255e251b..5ae8ef4996 100644
--- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
+++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json
@@ -21,6 +21,26 @@
 "endpoints": [
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.africa-south1.rep.googleapis.com/",
+"location": "africa-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.asia-east1.rep.googleapis.com/",
+"location": "asia-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.asia-east2.rep.googleapis.com/",
+"location": "asia-east2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.asia-northeast3.rep.googleapis.com/",
+"location": "asia-northeast3"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://dataflow.asia-south1.rep.googleapis.com/",
 "location": "asia-south1"
 },
@@ -31,6 +51,36 @@
 },
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.asia-southeast3.rep.googleapis.com/",
+"location": "asia-southeast3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.australia-southeast1.rep.googleapis.com/",
+"location": "australia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.australia-southeast2.rep.googleapis.com/",
+"location": "australia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.europe-central2.rep.googleapis.com/",
+"location": "europe-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.europe-southwest1.rep.googleapis.com/",
+"location": "europe-southwest1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.europe-west10.rep.googleapis.com/",
+"location": "europe-west10"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/",
 "location": "europe-west3"
 },
@@ -46,11 +96,36 @@
 },
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.me-central1.rep.googleapis.com/",
+"location": "me-central1"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/",
 "location": "me-central2"
 },
 {
 "description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.me-west1.rep.googleapis.com/",
+"location": "me-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.northamerica-northeast1.rep.googleapis.com/",
+"location": "northamerica-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.northamerica-south1.rep.googleapis.com/",
+"location": "northamerica-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://dataflow.southamerica-west1.rep.googleapis.com/",
+"location": "southamerica-west1"
+},
+{
+"description": "Regional Endpoint",
 "endpointUrl": "https://dataflow.us-central1.rep.googleapis.com/",
 "location": "us-central1"
 },
@@ -2260,7 +2335,7 @@
 }
 }
 },
-"revision": "20251003",
+"revision": "20251026",
 "rootUrl": "https://dataflow.googleapis.com/",
 "schemas": {
 "ApproximateProgress": {

From b082bcdea218f8eda4e3167f0d91086067f54326 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 25/70] feat(dataplex): update the api

#### dataplex:v1

The following keys were added:
- schemas.GoogleCloudDataplexV1DataQualityResult.properties.anomalyDetectionGeneratedAssets (Total Keys: 2)
- schemas.GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets (Total Keys: 10)
---
 ...aplex_v1.projects.locations.dataScans.html | 30 +++++++++++++
 ..._v1.projects.locations.dataScans.jobs.html | 12 ++++++
 docs/dyn/dataplex_v1.projects.locations.html  |  2 +-
 .../documents/dataplex.v1.json                | 42 ++++++++++++++++---
 4 files changed, 79 insertions(+), 7 deletions(-)

diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
index ba3de60f20..3c3ee66509 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html
@@ -284,6 +284,12 @@ 
Method Details

     "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
   },
   "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+    "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+      "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+      "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+    },
     "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
       "state": "A String", # Output only. Execution state for catalog publishing.
     },
@@ -788,6 +794,12 @@ 
Method Details

     "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
   },
   "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+    "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+      "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+      "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+    },
     "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
       "state": "A String", # Output only. Execution state for catalog publishing.
     },
@@ -1206,6 +1218,12 @@ 
Method Details

         "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
       },
       "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+        "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+          "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+          "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+          "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+          "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+        },
         "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
           "state": "A String", # Output only. Execution state for catalog publishing.
         },
@@ -1585,6 +1603,12 @@ 
Method Details

     "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
   },
   "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+    "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+      "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+      "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+    },
     "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
       "state": "A String", # Output only. Execution state for catalog publishing.
     },
@@ -1982,6 +2006,12 @@ 
Method Details

       "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
     },
     "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+      "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+        "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+        "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+        "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+        "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      },
       "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
         "state": "A String", # Output only. Execution state for catalog publishing.
       },
diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
index 297efe2992..717d6881b3 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html
@@ -333,6 +333,12 @@ 
Method Details

     "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
   },
   "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+    "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+      "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+      "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+      "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+    },
     "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
       "state": "A String", # Output only. Execution state for catalog publishing.
     },
@@ -680,6 +686,12 @@ 
Method Details

         "samplingPercent": 3.14, # Optional. The percentage of the records to be selected from the dataset for DataScan. Value can range between 0.0 and 100.0 with up to 3 significant decimal digits. Sampling is not applied if sampling_percent is not specified, 0 or 100.
       },
       "dataQualityResult": { # The output of a DataQualityScan. # Output only. The result of a data quality scan.
+        "anomalyDetectionGeneratedAssets": { # The assets generated by Anomaly Detection Data Scan. # Output only. The generated assets for anomaly detection.
+          "dataIntermediateTable": "A String", # Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+          "freshnessIntermediateTable": "A String", # Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+          "resultTable": "A String", # Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.
+          "volumeIntermediateTable": "A String", # Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID
+        },
         "catalogPublishingStatus": { # The status of publishing the data scan result as Dataplex Universal Catalog metadata. # Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.
           "state": "A String", # Output only. Execution state for catalog publishing.
         },
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index 5e23cbbad5..f03120825f 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -204,7 +204,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index 291e3ab7ef..3e73373adb 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -786,7 +786,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -7260,7 +7260,7 @@
 }
 }
 },
-"revision": "20251012",
+"revision": "20251027",
 "rootUrl": "https://dataplex.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -9162,6 +9162,11 @@
 "description": "The output of a DataQualityScan.",
 "id": "GoogleCloudDataplexV1DataQualityResult",
 "properties": {
+"anomalyDetectionGeneratedAssets": {
+"$ref": "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets",
+"description": "Output only. The generated assets for anomaly detection.",
+"readOnly": true
+},
 "catalogPublishingStatus": {
 "$ref": "GoogleCloudDataplexV1DataScanCatalogPublishingStatus",
 "description": "Output only. The status of publishing the data scan as Dataplex Universal Catalog metadata.",
@@ -9221,6 +9226,33 @@
 },
 "type": "object"
 },
+"GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets": {
+"description": "The assets generated by Anomaly Detection Data Scan.",
+"id": "GoogleCloudDataplexV1DataQualityResultAnomalyDetectionGeneratedAssets",
+"properties": {
+"dataIntermediateTable": {
+"description": "Output only. The intermediate table for data anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID",
+"readOnly": true,
+"type": "string"
+},
+"freshnessIntermediateTable": {
+"description": "Output only. The intermediate table for freshness anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID",
+"readOnly": true,
+"type": "string"
+},
+"resultTable": {
+"description": "Output only. The result table for anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID If the result table is set at AnomalyDetectionAssets, the result table here would be the same as the one set in the AnomalyDetectionAssets.result_table.",
+"readOnly": true,
+"type": "string"
+},
+"volumeIntermediateTable": {
+"description": "Output only. The intermediate table for volume anomaly detection. Format: PROJECT_ID.DATASET_ID.TABLE_ID",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDataplexV1DataQualityResultPostScanActionsResult": {
 "description": "The result of post scan actions of DataQualityScan job.",
 "id": "GoogleCloudDataplexV1DataQualityResultPostScanActionsResult",
@@ -9995,14 +10027,12 @@
 "enum": [
 "TRIGGER_UNSPECIFIED",
 "ON_DEMAND",
-"SCHEDULE",
-"ONE_TIME"
+"SCHEDULE"
 ],
 "enumDescriptions": [
 "An unspecified trigger type.",
 "Data scan triggers on demand.",
-"Data scan triggers as per schedule.",
-"Data scan is run one time on creation."
+"Data scan triggers as per schedule."
 ],
 "type": "string"
 },

From 46ecc1b97aee590e952a455f36a17ee57edc4878 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 26/70] feat(dataproc): update the api

#### dataproc:v1

The following keys were added:
- schemas.AnalyzeBatchRequest.properties.requestorId.deprecated (Total Keys: 1)
---
 ..._v1.projects.locations.workflowTemplates.html | 14 +++++++-------
 docs/dyn/dataproc_v1.projects.regions.jobs.html  | 16 ++++++++--------
 ...oc_v1.projects.regions.workflowTemplates.html | 14 +++++++-------
 .../discovery_cache/documents/dataproc.v1.json   |  5 +++--
 4 files changed, 25 insertions(+), 24 deletions(-)

diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
index 14138f3739..96b8d60b69 100644
--- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
+++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
@@ -246,7 +246,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -956,7 +956,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -1693,7 +1693,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -2494,7 +2494,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -3245,7 +3245,7 @@ 
Method Details

             },
           },
           "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-            "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+            "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
               "A String",
             ],
             "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -4064,7 +4064,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -4774,7 +4774,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
diff --git a/docs/dyn/dataproc_v1.projects.regions.jobs.html b/docs/dyn/dataproc_v1.projects.regions.jobs.html
index b529aa2f7a..2bb9063e18 100644
--- a/docs/dyn/dataproc_v1.projects.regions.jobs.html
+++ b/docs/dyn/dataproc_v1.projects.regions.jobs.html
@@ -258,7 +258,7 @@ 
Method Details

     },
   },
   "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
       "A String",
     ],
     "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -571,7 +571,7 @@ 
Method Details

     },
   },
   "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
       "A String",
     ],
     "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -912,7 +912,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -1215,7 +1215,7 @@ 
Method Details

     },
   },
   "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
       "A String",
     ],
     "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -1495,7 +1495,7 @@ 
Method Details

     },
   },
   "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
       "A String",
     ],
     "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -1836,7 +1836,7 @@ 
Method Details

       },
     },
     "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-      "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+      "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
         "A String",
       ],
       "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -2117,7 +2117,7 @@ 
Method Details

     },
   },
   "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+    "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
       "A String",
     ],
     "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -2400,7 +2400,7 @@ 
Method Details

       },
     },
     "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-      "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+      "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
         "A String",
       ],
       "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html
index dacaff0434..2cf9170c54 100644
--- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html
+++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html
@@ -246,7 +246,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -956,7 +956,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -1693,7 +1693,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -2494,7 +2494,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -3245,7 +3245,7 @@ 
Method Details

             },
           },
           "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-            "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+            "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
               "A String",
             ],
             "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -4064,7 +4064,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
@@ -4774,7 +4774,7 @@ 
Method Details

         },
       },
       "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. # Optional. Job is a PySpark job.
-        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
+        "archiveUris": [ # Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.
           "A String",
         ],
         "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json
index da46b8d03a..ca97f87d90 100644
--- a/googleapiclient/discovery_cache/documents/dataproc.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json
@@ -5022,7 +5022,7 @@
 }
 }
 },
-"revision": "20251003",
+"revision": "20251021",
 "rootUrl": "https://dataproc.googleapis.com/",
 "schemas": {
 "AcceleratorConfig": {
@@ -5229,6 +5229,7 @@
 "type": "string"
 },
 "requestorId": {
+"deprecated": true,
 "description": "Optional. The requestor ID is used to identify if the request comes from a GCA investigation or the old Ask Gemini Experience. ",
 "type": "string"
 }
@@ -9289,7 +9290,7 @@
 "id": "PySparkJob",
 "properties": {
 "archiveUris": {
-"description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
+"description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation.",
 "items": {
 "type": "string"
 },

From 94712425b6c1a43eac2f609efa2bbe0130c1d157 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 27/70] feat(datastream): update the api

#### datastream:v1

The following keys were added:
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.EventFilter (Total Keys: 3)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
- schemas.StartBackfillJobRequest.properties.eventFilter.$ref (Total Keys: 1)

#### datastream:v1alpha1

The following keys were added:
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
---
 ...ream_v1.projects.locations.operations.html |  8 +++--
 ...astream_v1.projects.locations.streams.html |  2 +-
 ...v1.projects.locations.streams.objects.html |  3 ++
 ...1alpha1.projects.locations.operations.html |  8 +++--
 .../documents/datastream.v1.json              | 34 +++++++++++++++++--
 .../documents/datastream.v1alpha1.json        | 14 +++++++-
 6 files changed, 60 insertions(+), 9 deletions(-)

diff --git a/docs/dyn/datastream_v1.projects.locations.operations.html b/docs/dyn/datastream_v1.projects.locations.operations.html
index d3c7c4b678..c6cd922dcd 100644
--- a/docs/dyn/datastream_v1.projects.locations.operations.html
+++ b/docs/dyn/datastream_v1.projects.locations.operations.html
@@ -87,7 +87,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -176,7 +176,7 @@ 
Method Details

 
 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
   
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }

 

 
diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html
index d0e1e20960..afd823ec53 100644
--- a/docs/dyn/datastream_v1.projects.locations.streams.html
+++ b/docs/dyn/datastream_v1.projects.locations.streams.html
@@ -2318,7 +2318,7 @@ 
Method Details

     },
     "specificStartPosition": { # CDC strategy to start replicating from a specific position in the source. # Optional. Start replicating from a specific position in the source.
       "mongodbChangeStreamPosition": { # MongoDB change stream position # MongoDB change stream position to start replicating from.
-        "startTime": "A String", # Required. The timestamp (in epoch seconds) to start change stream from.
+        "startTime": "A String", # Required. The timestamp to start change stream from.
       },
       "mysqlGtidPosition": { # MySQL GTID position # MySQL GTID set to start replicating from.
         "gtidSet": "A String", # Required. The gtid set to start replication from.
diff --git a/docs/dyn/datastream_v1.projects.locations.streams.objects.html b/docs/dyn/datastream_v1.projects.locations.streams.objects.html
index 7da6506531..50e3807252 100644
--- a/docs/dyn/datastream_v1.projects.locations.streams.objects.html
+++ b/docs/dyn/datastream_v1.projects.locations.streams.objects.html
@@ -388,6 +388,9 @@ 
Method Details

     The object takes the form of:
 
 { # Request for manually initiating a backfill job for a specific stream object.
+  "eventFilter": { # Represents a filter for included data on a stream object. # Optional. Optional event filter. If not set, or empty, the backfill will be performed on the entire object. This is currently used for partial backfill and only supported for SQL Server sources.
+    "sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. E.g., "t.key1 = 'value1' AND t.key2 = 'value2'".
+  },
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/datastream_v1alpha1.projects.locations.operations.html b/docs/dyn/datastream_v1alpha1.projects.locations.operations.html
index c28cd8e9b8..75df76fc34 100644
--- a/docs/dyn/datastream_v1alpha1.projects.locations.operations.html
+++ b/docs/dyn/datastream_v1alpha1.projects.locations.operations.html
@@ -87,7 +87,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -176,7 +176,7 @@ 
Method Details

 
 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
   
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }

 

 
diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json
index a93aa680ad..e466d2bc6d 100644
--- a/googleapiclient/discovery_cache/documents/datastream.v1.json
+++ b/googleapiclient/discovery_cache/documents/datastream.v1.json
@@ -560,6 +560,11 @@
 "description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1/{+name}/operations",
@@ -1261,7 +1266,7 @@
 }
 }
 },
-"revision": "20250827",
+"revision": "20251021",
 "rootUrl": "https://datastream.googleapis.com/",
 "schemas": {
 "AppendOnly": {
@@ -1782,6 +1787,17 @@
 },
 "type": "object"
 },
+"EventFilter": {
+"description": "Represents a filter for included data on a stream object.",
+"id": "EventFilter",
+"properties": {
+"sqlWhereClause": {
+"description": "An SQL-query Where clause selecting which data should be included, not including the \"WHERE\" keyword. E.g., \"t.key1 = 'value1' AND t.key2 = 'value2'\".",
+"type": "string"
+}
+},
+"type": "object"
+},
 "FetchStaticIpsResponse": {
 "description": "Response message for a 'FetchStaticIps' response.",
 "id": "FetchStaticIpsResponse",
@@ -1986,6 +2002,13 @@
 "$ref": "Operation"
 },
 "type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -2160,7 +2183,7 @@
 "id": "MongodbChangeStreamPosition",
 "properties": {
 "startTime": {
-"description": "Required. The timestamp (in epoch seconds) to start change stream from.",
+"description": "Required. The timestamp to start change stream from.",
 "format": "google-datetime",
 "type": "string"
 }
@@ -3821,7 +3844,12 @@
 "StartBackfillJobRequest": {
 "description": "Request for manually initiating a backfill job for a specific stream object.",
 "id": "StartBackfillJobRequest",
-"properties": {},
+"properties": {
+"eventFilter": {
+"$ref": "EventFilter",
+"description": "Optional. Optional event filter. If not set, or empty, the backfill will be performed on the entire object. This is currently used for partial backfill and only supported for SQL Server sources."
+}
+},
 "type": "object"
 },
 "StartBackfillJobResponse": {
diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json
index d2241c6614..841704e76f 100644
--- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json
@@ -553,6 +553,11 @@
 "description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1alpha1/{+name}/operations",
@@ -1230,7 +1235,7 @@
 }
 }
 },
-"revision": "20250817",
+"revision": "20251021",
 "rootUrl": "https://datastream.googleapis.com/",
 "schemas": {
 "AvroFileFormat": {
@@ -1711,6 +1716,13 @@
 "$ref": "Operation"
 },
 "type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"

From b5dbb37c9de1093601e5258e3390dbcba29090ab Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:12 +0000
Subject: [PATCH 28/70] feat(developerconnect): update the api

#### developerconnect:v1

The following keys were added:
- schemas.AppHubService (Total Keys: 8)
- schemas.GoogleCloudRun (Total Keys: 3)
- schemas.RuntimeConfig.properties.appHubService (Total Keys: 2)
- schemas.RuntimeConfig.properties.googleCloudRun (Total Keys: 2)
---
 ...v1.projects.locations.insightsConfigs.html | 32 +++++++++++++
 .../documents/developerconnect.v1.json        | 45 ++++++++++++++++++-
 2 files changed, 76 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html b/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html
index 77fa1430a1..c5476f42df 100644
--- a/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html
+++ b/docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.html
@@ -146,6 +146,11 @@ 
Method Details

   "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
   "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed.
     { # RuntimeConfig represents the runtimes where the application is deployed.
+      "appHubService": { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
+        "apphubService": "A String", # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
+        "criticality": "A String", # Output only. The criticality of the App Hub Service.
+        "environment": "A String", # Output only. The environment of the App Hub Service.
+      },
       "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
         "criticality": "A String", # Output only. The criticality of the App Hub Workload.
         "environment": "A String", # Output only. The environment of the App Hub Workload.
@@ -155,6 +160,9 @@ 
Method Details

         "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
         "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
       },
+      "googleCloudRun": { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
+        "serviceUri": "A String", # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
+      },
       "state": "A String", # Output only. The state of the Runtime.
       "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
     },
@@ -282,6 +290,11 @@ 
Method Details

   "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
   "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed.
     { # RuntimeConfig represents the runtimes where the application is deployed.
+      "appHubService": { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
+        "apphubService": "A String", # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
+        "criticality": "A String", # Output only. The criticality of the App Hub Service.
+        "environment": "A String", # Output only. The environment of the App Hub Service.
+      },
       "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
         "criticality": "A String", # Output only. The criticality of the App Hub Workload.
         "environment": "A String", # Output only. The environment of the App Hub Workload.
@@ -291,6 +304,9 @@ 
Method Details

         "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
         "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
       },
+      "googleCloudRun": { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
+        "serviceUri": "A String", # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
+      },
       "state": "A String", # Output only. The state of the Runtime.
       "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
     },
@@ -356,6 +372,11 @@ 
Method Details

       "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
       "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed.
         { # RuntimeConfig represents the runtimes where the application is deployed.
+          "appHubService": { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
+            "apphubService": "A String", # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
+            "criticality": "A String", # Output only. The criticality of the App Hub Service.
+            "environment": "A String", # Output only. The environment of the App Hub Service.
+          },
           "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
             "criticality": "A String", # Output only. The criticality of the App Hub Workload.
             "environment": "A String", # Output only. The environment of the App Hub Workload.
@@ -365,6 +386,9 @@ 
Method Details

             "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
             "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
           },
+          "googleCloudRun": { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
+            "serviceUri": "A String", # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
+          },
           "state": "A String", # Output only. The state of the Runtime.
           "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
         },
@@ -439,6 +463,11 @@ 
Method Details

   "reconciling": True or False, # Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of InsightsConfig does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
   "runtimeConfigs": [ # Output only. The runtime configurations where the application is deployed.
     { # RuntimeConfig represents the runtimes where the application is deployed.
+      "appHubService": { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
+        "apphubService": "A String", # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
+        "criticality": "A String", # Output only. The criticality of the App Hub Service.
+        "environment": "A String", # Output only. The environment of the App Hub Service.
+      },
       "appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
         "criticality": "A String", # Output only. The criticality of the App Hub Workload.
         "environment": "A String", # Output only. The environment of the App Hub Workload.
@@ -448,6 +477,9 @@ 
Method Details

         "cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
         "deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
       },
+      "googleCloudRun": { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
+        "serviceUri": "A String", # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
+      },
       "state": "A String", # Output only. The state of the Runtime.
       "uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
     },
diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json
index cabfd50427..af65c5b7e5 100644
--- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json
+++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json
@@ -1606,7 +1606,7 @@
 }
 }
 },
-"revision": "20251003",
+"revision": "20251016",
 "rootUrl": "https://developerconnect.googleapis.com/",
 "schemas": {
 "AccountConnector": {
@@ -1659,6 +1659,28 @@
 },
 "type": "object"
 },
+"AppHubService": {
+"description": "AppHubService represents the App Hub Service.",
+"id": "AppHubService",
+"properties": {
+"apphubService": {
+"description": "Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.",
+"readOnly": true,
+"type": "string"
+},
+"criticality": {
+"description": "Output only. The criticality of the App Hub Service.",
+"readOnly": true,
+"type": "string"
+},
+"environment": {
+"description": "Output only. The environment of the App Hub Service.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "AppHubWorkload": {
 "description": "AppHubWorkload represents the App Hub Workload.",
 "id": "AppHubWorkload",
@@ -2298,6 +2320,17 @@
 },
 "type": "object"
 },
+"GoogleCloudRun": {
+"description": "GoogleCloudRun represents the Cloud Run runtime.",
+"id": "GoogleCloudRun",
+"properties": {
+"serviceUri": {
+"description": "Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "HttpBody": {
 "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.",
 "id": "HttpBody",
@@ -2873,6 +2906,11 @@
 "description": "RuntimeConfig represents the runtimes where the application is deployed.",
 "id": "RuntimeConfig",
 "properties": {
+"appHubService": {
+"$ref": "AppHubService",
+"description": "Output only. App Hub Service.",
+"readOnly": true
+},
 "appHubWorkload": {
 "$ref": "AppHubWorkload",
 "description": "Output only. App Hub Workload.",
@@ -2883,6 +2921,11 @@
 "description": "Output only. Google Kubernetes Engine runtime.",
 "readOnly": true
 },
+"googleCloudRun": {
+"$ref": "GoogleCloudRun",
+"description": "Output only. Cloud Run runtime.",
+"readOnly": true
+},
 "state": {
 "description": "Output only. The state of the Runtime.",
 "enum": [

From eb29fdfc7d374ca0fa8a4521dfd03adf5f9d2aaa Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:13 +0000
Subject: [PATCH 29/70] feat(dfareporting): update the api

#### dfareporting:v4

The following keys were added:
- schemas.Ad.properties.contextualKeywordTargeting.$ref (Total Keys: 1)
- schemas.ContextualKeyword (Total Keys: 7)
- schemas.TargetingTemplate.properties.contextualKeywordTargeting.$ref (Total Keys: 1)

#### dfareporting:v5

The following keys were added:
- schemas.Ad.properties.contextualKeywordTargeting.$ref (Total Keys: 1)
- schemas.ContextualKeyword (Total Keys: 7)
- schemas.TargetingTemplate.properties.contextualKeywordTargeting.$ref (Total Keys: 1)
---
 docs/dyn/dfareporting_v4.ads.html             | 56 +++++++++++++++++++
 docs/dyn/dfareporting_v4.placements.html      | 16 +++---
 docs/dyn/dfareporting_v4.sites.html           | 16 +++---
 .../dfareporting_v4.targetingTemplates.html   | 56 +++++++++++++++++++
 docs/dyn/dfareporting_v5.ads.html             | 56 +++++++++++++++++++
 docs/dyn/dfareporting_v5.placements.html      | 16 +++---
 docs/dyn/dfareporting_v5.sites.html           | 16 +++---
 .../dfareporting_v5.targetingTemplates.html   | 56 +++++++++++++++++++
 .../documents/dfareporting.v4.json            | 53 ++++++++++++++++--
 .../documents/dfareporting.v5.json            | 53 ++++++++++++++++--
 10 files changed, 350 insertions(+), 44 deletions(-)

diff --git a/docs/dyn/dfareporting_v4.ads.html b/docs/dyn/dfareporting_v4.ads.html
index 686453cfea..cc65a58dcc 100644
--- a/docs/dyn/dfareporting_v4.ads.html
+++ b/docs/dyn/dfareporting_v4.ads.html
@@ -151,6 +151,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -470,6 +477,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -787,6 +801,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -1155,6 +1176,13 @@ 
Method Details

       },
       "comments": "A String", # Comments for this ad.
       "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+      "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+        "keywords": [ # Contextual keywords that this ad targets
+          { # Contains information about a Contextual Keyword that can be targeted by ads.
+            "keyword": "A String", # The keyword that can be targeted by ads.
+          },
+        ],
+      },
       "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
         "time": "A String", # Timestamp of the last change in milliseconds since epoch.
       },
@@ -1493,6 +1521,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -1810,6 +1845,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -2129,6 +2171,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -2446,6 +2495,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
diff --git a/docs/dyn/dfareporting_v4.placements.html b/docs/dyn/dfareporting_v4.placements.html
index 30e82eabfb..6148e09e1d 100644
--- a/docs/dyn/dfareporting_v4.placements.html
+++ b/docs/dyn/dfareporting_v4.placements.html
@@ -180,7 +180,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -414,7 +414,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -646,7 +646,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -940,7 +940,7 @@ 
Method Details

       "accountId": "A String", # Account ID of this placement. This field can be left blank.
       "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
       "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
       "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
         { # Represents the dimensions of ads, placements, creatives, or creative assets.
           "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1191,7 +1191,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1423,7 +1423,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1657,7 +1657,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1889,7 +1889,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
diff --git a/docs/dyn/dfareporting_v4.sites.html b/docs/dyn/dfareporting_v4.sites.html
index 361be66cda..1449d9d465 100644
--- a/docs/dyn/dfareporting_v4.sites.html
+++ b/docs/dyn/dfareporting_v4.sites.html
@@ -118,7 +118,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -236,7 +236,7 @@ 
Method Details

 
 { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -352,7 +352,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -500,7 +500,7 @@ 
Method Details

   "sites": [ # Site collection.
     { # Contains properties of a site.
       "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
       "approved": True or False, # Whether this site is approved.
       "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
       "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -635,7 +635,7 @@ 
Method Details

 
 { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -751,7 +751,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -869,7 +869,7 @@ 
Method Details

 
 { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -985,7 +985,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
diff --git a/docs/dyn/dfareporting_v4.targetingTemplates.html b/docs/dyn/dfareporting_v4.targetingTemplates.html
index ae73b872bf..9936f8e499 100644
--- a/docs/dyn/dfareporting_v4.targetingTemplates.html
+++ b/docs/dyn/dfareporting_v4.targetingTemplates.html
@@ -127,6 +127,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -294,6 +301,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -459,6 +473,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -648,6 +669,13 @@ 
Method Details

         "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
         "value": "A String", # The value of the dimension.
       },
+      "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+        "keywords": [ # Contextual keywords that this ad targets
+          { # Contains information about a Contextual Keyword that can be targeted by ads.
+            "keyword": "A String", # The keyword that can be targeted by ads.
+          },
+        ],
+      },
       "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
         "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
           "A String",
@@ -832,6 +860,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -997,6 +1032,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -1164,6 +1206,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -1329,6 +1378,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
diff --git a/docs/dyn/dfareporting_v5.ads.html b/docs/dyn/dfareporting_v5.ads.html
index c0645af3c2..3ab8e7efe9 100644
--- a/docs/dyn/dfareporting_v5.ads.html
+++ b/docs/dyn/dfareporting_v5.ads.html
@@ -151,6 +151,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -470,6 +477,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -787,6 +801,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -1155,6 +1176,13 @@ 
Method Details

       },
       "comments": "A String", # Comments for this ad.
       "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+      "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+        "keywords": [ # Contextual keywords that this ad targets
+          { # Contains information about a Contextual Keyword that can be targeted by ads.
+            "keyword": "A String", # The keyword that can be targeted by ads.
+          },
+        ],
+      },
       "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
         "time": "A String", # Timestamp of the last change in milliseconds since epoch.
       },
@@ -1493,6 +1521,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -1810,6 +1845,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -2129,6 +2171,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
@@ -2446,6 +2495,13 @@ 
Method Details

   },
   "comments": "A String", # Comments for this ad.
   "compatibility": "A String", # Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are only used for existing default ads. New mobile placements must be assigned DISPLAY or DISPLAY_INTERSTITIAL and default ads created for those placements will be limited to those compatibility types. IN_STREAM_VIDEO refers to rendering in-stream video ads developed with the VAST standard.
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting information for this ad.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "createInfo": { # Modification timestamp. # Information about the creation of this ad. This is a read-only field.
     "time": "A String", # Timestamp of the last change in milliseconds since epoch.
   },
diff --git a/docs/dyn/dfareporting_v5.placements.html b/docs/dyn/dfareporting_v5.placements.html
index 396890e3b8..266cf221af 100644
--- a/docs/dyn/dfareporting_v5.placements.html
+++ b/docs/dyn/dfareporting_v5.placements.html
@@ -180,7 +180,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -414,7 +414,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -646,7 +646,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -940,7 +940,7 @@ 
Method Details

       "accountId": "A String", # Account ID of this placement. This field can be left blank.
       "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
       "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
       "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
         { # Represents the dimensions of ads, placements, creatives, or creative assets.
           "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1191,7 +1191,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1423,7 +1423,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1657,7 +1657,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
@@ -1889,7 +1889,7 @@ 
Method Details

   "accountId": "A String", # Account ID of this placement. This field can be left blank.
   "activeStatus": "A String", # Whether this placement is active, inactive, archived or permanently archived.
   "adBlockingOptOut": True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "additionalSizes": [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
     { # Represents the dimensions of ads, placements, creatives, or creative assets.
       "height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
diff --git a/docs/dyn/dfareporting_v5.sites.html b/docs/dyn/dfareporting_v5.sites.html
index b34cd295ad..598c7631c0 100644
--- a/docs/dyn/dfareporting_v5.sites.html
+++ b/docs/dyn/dfareporting_v5.sites.html
@@ -118,7 +118,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -236,7 +236,7 @@ 
Method Details

 
 { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -352,7 +352,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -500,7 +500,7 @@ 
Method Details

   "sites": [ # Site collection.
     { # Contains properties of a site.
       "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+      "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
       "approved": True or False, # Whether this site is approved.
       "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
       "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -635,7 +635,7 @@ 
Method Details

 
 { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -751,7 +751,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -869,7 +869,7 @@ 
Method Details

 
 { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
@@ -985,7 +985,7 @@ 
Method Details

 
     { # Contains properties of a site.
   "accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
-  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv
+  "adServingPlatformId": "A String", # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
   "approved": True or False, # Whether this site is approved.
   "directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
   "directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
diff --git a/docs/dyn/dfareporting_v5.targetingTemplates.html b/docs/dyn/dfareporting_v5.targetingTemplates.html
index b091144136..84442bda23 100644
--- a/docs/dyn/dfareporting_v5.targetingTemplates.html
+++ b/docs/dyn/dfareporting_v5.targetingTemplates.html
@@ -127,6 +127,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -294,6 +301,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -459,6 +473,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -648,6 +669,13 @@ 
Method Details

         "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
         "value": "A String", # The value of the dimension.
       },
+      "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+        "keywords": [ # Contextual keywords that this ad targets
+          { # Contains information about a Contextual Keyword that can be targeted by ads.
+            "keyword": "A String", # The keyword that can be targeted by ads.
+          },
+        ],
+      },
       "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
         "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
           "A String",
@@ -832,6 +860,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -997,6 +1032,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -1164,6 +1206,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
@@ -1329,6 +1378,13 @@ 
Method Details

     "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
     "value": "A String", # The value of the dimension.
   },
+  "contextualKeywordTargeting": { # Contextual Keyword Targeting. # Optional. Contextual keyword targeting criteria.
+    "keywords": [ # Contextual keywords that this ad targets
+      { # Contains information about a Contextual Keyword that can be targeted by ads.
+        "keyword": "A String", # The keyword that can be targeted by ads.
+      },
+    ],
+  },
   "dayPartTargeting": { # Day Part Targeting. # Time and day targeting criteria.
     "daysOfWeek": [ # Days of the week when the ad will serve. Acceptable values are: - "SUNDAY" - "MONDAY" - "TUESDAY" - "WEDNESDAY" - "THURSDAY" - "FRIDAY" - "SATURDAY"
       "A String",
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v4.json b/googleapiclient/discovery_cache/documents/dfareporting.v4.json
index af9ea5235c..c1361cbde7 100644
--- a/googleapiclient/discovery_cache/documents/dfareporting.v4.json
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v4.json
@@ -10465,7 +10465,7 @@
 }
 }
 },
-"revision": "20251009",
+"revision": "20251023",
 "rootUrl": "https://dfareporting.googleapis.com/",
 "schemas": {
 "Account": {
@@ -10989,6 +10989,10 @@
 ],
 "type": "string"
 },
+"contextualKeywordTargeting": {
+"$ref": "ContextualKeywordTargeting",
+"description": "Optional. Contextual keyword targeting information for this ad."
+},
 "createInfo": {
 "$ref": "LastModifiedInfo",
 "description": "Information about the creation of this ad. This is a read-only field."
@@ -12583,6 +12587,31 @@
 },
 "type": "object"
 },
+"ContextualKeyword": {
+"description": "Contains information about a Contextual Keyword that can be targeted by ads.",
+"id": "ContextualKeyword",
+"properties": {
+"keyword": {
+"description": "The keyword that can be targeted by ads.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ContextualKeywordTargeting": {
+"description": "Contextual Keyword Targeting.",
+"id": "ContextualKeywordTargeting",
+"properties": {
+"keywords": {
+"description": "Contextual keywords that this ad targets",
+"items": {
+"$ref": "ContextualKeyword"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Conversion": {
 "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
 "id": "Conversion",
@@ -12961,7 +12990,10 @@
 "CREATIVE_AUTHORING_SOURCE_GWD",
 "CREATIVE_AUTHORING_SOURCE_ACS",
 "CREATIVE_AUTHORING_SOURCE_ADOBE",
-"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI"
+"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI",
+"CREATIVE_AUTHORING_SOURCE_REMBRAND",
+"CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO",
+"CREATIVE_AUTHORING_SOURCE_BORNLOGIC"
 ],
 "enumDescriptions": [
 "DCM-UI or external API used to author the creative.",
@@ -12970,7 +13002,10 @@
 "Google Web Designer used to author the creative.",
 "ACS-UI used to author the creative.",
 "Creative authoring source is Adobe.",
-"Creative authoring source is Typeface.ai."
+"Creative authoring source is Typeface.ai.",
+"Creative authoring source is Rembrand.",
+"Creative authoring source is Trackto.",
+"Creative authoring source is Bornlogic."
 ],
 "type": "string"
 },
@@ -19091,7 +19126,7 @@
 "type": "boolean"
 },
 "adServingPlatformId": {
-"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint",
 "format": "int64",
 "type": "string"
 },
@@ -21207,7 +21242,7 @@
 "type": "string"
 },
 "adServingPlatformId": {
-"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint",
 "format": "int64",
 "type": "string"
 },
@@ -22130,6 +22165,10 @@
 "$ref": "DimensionValue",
 "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
 },
+"contextualKeywordTargeting": {
+"$ref": "ContextualKeywordTargeting",
+"description": "Optional. Contextual keyword targeting criteria."
+},
 "dayPartTargeting": {
 "$ref": "DayPartTargeting",
 "description": "Time and day targeting criteria."
@@ -22482,13 +22521,15 @@
 "AD_ID_OFFICIAL",
 "CLEARCAST",
 "DCM",
-"ARPP"
+"ARPP",
+"CUSV"
 ],
 "enumDescriptions": [
 "",
 "",
 "",
 "",
+"",
 ""
 ],
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/dfareporting.v5.json b/googleapiclient/discovery_cache/documents/dfareporting.v5.json
index 421645c156..279c28dca0 100644
--- a/googleapiclient/discovery_cache/documents/dfareporting.v5.json
+++ b/googleapiclient/discovery_cache/documents/dfareporting.v5.json
@@ -10005,7 +10005,7 @@
 }
 }
 },
-"revision": "20251009",
+"revision": "20251023",
 "rootUrl": "https://dfareporting.googleapis.com/",
 "schemas": {
 "Account": {
@@ -10529,6 +10529,10 @@
 ],
 "type": "string"
 },
+"contextualKeywordTargeting": {
+"$ref": "ContextualKeywordTargeting",
+"description": "Optional. Contextual keyword targeting information for this ad."
+},
 "createInfo": {
 "$ref": "LastModifiedInfo",
 "description": "Information about the creation of this ad. This is a read-only field."
@@ -12057,6 +12061,31 @@
 },
 "type": "object"
 },
+"ContextualKeyword": {
+"description": "Contains information about a Contextual Keyword that can be targeted by ads.",
+"id": "ContextualKeyword",
+"properties": {
+"keyword": {
+"description": "The keyword that can be targeted by ads.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ContextualKeywordTargeting": {
+"description": "Contextual Keyword Targeting.",
+"id": "ContextualKeywordTargeting",
+"properties": {
+"keywords": {
+"description": "Contextual keywords that this ad targets",
+"items": {
+"$ref": "ContextualKeyword"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Conversion": {
 "description": "A Conversion represents when a user successfully performs a desired action after seeing an ad.",
 "id": "Conversion",
@@ -12435,7 +12464,10 @@
 "CREATIVE_AUTHORING_SOURCE_GWD",
 "CREATIVE_AUTHORING_SOURCE_ACS",
 "CREATIVE_AUTHORING_SOURCE_ADOBE",
-"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI"
+"CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI",
+"CREATIVE_AUTHORING_SOURCE_REMBRAND",
+"CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO",
+"CREATIVE_AUTHORING_SOURCE_BORNLOGIC"
 ],
 "enumDescriptions": [
 "DCM-UI or external API used to author the creative.",
@@ -12444,7 +12476,10 @@
 "Google Web Designer used to author the creative.",
 "ACS-UI used to author the creative.",
 "Creative authoring source is Adobe.",
-"Creative authoring source is Typeface.ai."
+"Creative authoring source is Typeface.ai.",
+"Creative authoring source is Rembrand.",
+"Creative authoring source is Trackto.",
+"Creative authoring source is Bornlogic."
 ],
 "type": "string"
 },
@@ -18273,7 +18308,7 @@
 "type": "boolean"
 },
 "adServingPlatformId": {
-"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint",
 "format": "int64",
 "type": "string"
 },
@@ -20078,7 +20113,7 @@
 "type": "string"
 },
 "adServingPlatformId": {
-"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+"description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint",
 "format": "int64",
 "type": "string"
 },
@@ -21001,6 +21036,10 @@
 "$ref": "DimensionValue",
 "description": "Dimension value for the ID of the advertiser. This is a read-only, auto-generated field."
 },
+"contextualKeywordTargeting": {
+"$ref": "ContextualKeywordTargeting",
+"description": "Optional. Contextual keyword targeting criteria."
+},
 "dayPartTargeting": {
 "$ref": "DayPartTargeting",
 "description": "Time and day targeting criteria."
@@ -21353,13 +21392,15 @@
 "AD_ID_OFFICIAL",
 "CLEARCAST",
 "DCM",
-"ARPP"
+"ARPP",
+"CUSV"
 ],
 "enumDescriptions": [
 "",
 "",
 "",
 "",
+"",
 ""
 ],
 "type": "string"

From 0d073639ba2dd3cf64711a0b2e765c69cf40f301 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:13 +0000
Subject: [PATCH 30/70] feat(dialogflow): update the api

#### dialogflow:v2

The following keys were added:
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)

#### dialogflow:v2beta1

The following keys were added:
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)

#### dialogflow:v3

The following keys were added:
- schemas.GoogleCloudDialogflowCxV3CodeBlock (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3Playbook.properties.codeBlock.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3Playbook.properties.inlineActions (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3ToolAuthentication.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)

#### dialogflow:v3beta1

The following keys were added:
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1CodeBlock (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1Playbook.properties.codeBlock.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3beta1Playbook.properties.inlineActions (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1ToolAuthentication.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig (Total Keys: 3)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebService.properties.serviceAccountAuthConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig (Total Keys: 3)
---
 .../dyn/dialogflow_v2.projects.locations.html |  2 +-
 ...ialogflow_v2.projects.locations.tools.html | 12 ++--
 ...dialogflow_v2beta1.projects.locations.html |  2 +-
 ...flow_v2beta1.projects.locations.tools.html | 12 ++--
 ...rojects.locations.agents.environments.html | 30 ++++++++
 ...3.projects.locations.agents.playbooks.html | 36 ++++++++++
 ...s.locations.agents.playbooks.versions.html | 30 ++++++++
 ...ow_v3.projects.locations.agents.tools.html | 18 +++++
 ...jects.locations.agents.tools.versions.html | 15 ++++
 ...v3.projects.locations.agents.webhooks.html | 36 ++++++++++
 .../dyn/dialogflow_v3.projects.locations.html |  2 +-
 ...ojects.locations.agents.conversations.html | 12 ++++
 ...rojects.locations.agents.environments.html | 30 ++++++++
 ...1.projects.locations.agents.playbooks.html | 36 ++++++++++
 ...s.locations.agents.playbooks.versions.html | 30 ++++++++
 ...beta1.projects.locations.agents.tools.html | 18 +++++
 ...jects.locations.agents.tools.versions.html | 15 ++++
 ...a1.projects.locations.agents.webhooks.html | 36 ++++++++++
 ...dialogflow_v3beta1.projects.locations.html |  2 +-
 .../documents/dialogflow.v2.json              | 36 +++++++++-
 .../documents/dialogflow.v2beta1.json         | 36 +++++++++-
 .../documents/dialogflow.v3.json              | 72 ++++++++++++++++++-
 .../documents/dialogflow.v3beta1.json         | 72 ++++++++++++++++++-
 23 files changed, 564 insertions(+), 26 deletions(-)

diff --git a/docs/dyn/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html
index b7645f82a2..640ed53c94 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.html
@@ -277,7 +277,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/dialogflow_v2.projects.locations.tools.html b/docs/dyn/dialogflow_v2.projects.locations.tools.html
index 5db0989ee6..d5784999a5 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.tools.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.tools.html
@@ -181,7 +181,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -273,7 +273,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -389,7 +389,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -492,7 +492,7 @@ 
Method Details

         "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
           "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
             { # The CA certificate.
-              "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+              "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
               "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
             },
           ],
@@ -601,7 +601,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -693,7 +693,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.html
index 3dac7ebcd7..cbe3f5a0f5 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.html
@@ -272,7 +272,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.tools.html b/docs/dyn/dialogflow_v2beta1.projects.locations.tools.html
index f710a8b9f8..fe7c2b1221 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.tools.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.tools.html
@@ -181,7 +181,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -273,7 +273,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -389,7 +389,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -492,7 +492,7 @@ 
Method Details

         "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
           "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
             { # The CA certificate.
-              "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+              "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
               "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
             },
           ],
@@ -601,7 +601,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
@@ -693,7 +693,7 @@ 
Method Details

     "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification.
       "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification.
         { # The CA certificate.
-          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")
+          "cert": "A String", # Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") ```
           "displayName": "A String", # Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates.
         },
       ],
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html
index f904cdc03b..35cc6bcd98 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.html
@@ -192,6 +192,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -227,6 +230,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
@@ -393,6 +399,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -428,6 +437,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
@@ -510,6 +522,9 @@ 
Method Details

                   "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                 },
               },
+              "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+              },
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
               "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
               "username": "A String", # The user name for HTTP Basic authentication.
@@ -545,6 +560,9 @@ 
Method Details

                     "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                   },
                 },
+                "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                  "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+                },
                 "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                 "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
                 "username": "A String", # The user name for HTTP Basic authentication.
@@ -644,6 +662,9 @@ 
Method Details

                   "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                 },
               },
+              "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+              },
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
               "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
               "username": "A String", # The user name for HTTP Basic authentication.
@@ -679,6 +700,9 @@ 
Method Details

                     "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                   },
                 },
+                "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                  "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+                },
                 "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                 "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
                 "username": "A String", # The user name for HTTP Basic authentication.
@@ -769,6 +793,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -804,6 +831,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.html b/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.html
index f733ad1e79..e242313965 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.html
@@ -127,6 +127,9 @@ 
Method Details

     The object takes the form of:
 
 { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -486,6 +489,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -559,6 +565,9 @@ 
Method Details

   An object of the form:
 
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -918,6 +927,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1059,6 +1071,9 @@ 
Method Details

   An object of the form:
 
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1418,6 +1433,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1551,6 +1569,9 @@ 
Method Details

   "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
   "playbooks": [ # The list of playbooks. There will be a maximum number of items returned based on the page_size field in the request.
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+      "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+        "code": "A String", # Optional. Source code of the block in Python.
+      },
       "createTime": "A String", # Output only. The timestamp of initial playbook creation.
       "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
       "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1910,6 +1931,9 @@ 
Method Details

           },
         },
       ],
+      "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+        "A String",
+      ],
       "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
         { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
           "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2001,6 +2025,9 @@ 
Method Details

     The object takes the form of:
 
 { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2360,6 +2387,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2434,6 +2464,9 @@ 
Method Details

   An object of the form:
 
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2793,6 +2826,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.versions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.versions.html
index 1e2d5de964..87bf7ff4b4 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.versions.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.playbooks.versions.html
@@ -177,6 +177,9 @@ 
Method Details

   ],
   "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -536,6 +539,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -677,6 +683,9 @@ 
Method Details

   ],
   "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1036,6 +1045,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1202,6 +1214,9 @@ 
Method Details

   ],
   "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1561,6 +1576,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1714,6 +1732,9 @@ 
Method Details

       ],
       "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
       "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+        "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+          "code": "A String", # Optional. Source code of the block in Python.
+        },
         "createTime": "A String", # Output only. The timestamp of initial playbook creation.
         "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
         "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2073,6 +2094,9 @@ 
Method Details

             },
           },
         ],
+        "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+          "A String",
+        ],
         "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
           { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
             "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2178,6 +2202,9 @@ 
Method Details

 
     { # The response message for Playbooks.RestorePlaybookVersion.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # The updated playbook.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2537,6 +2564,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.tools.html b/docs/dyn/dialogflow_v3.projects.locations.agents.tools.html
index 251852d6b4..38d986ad52 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.tools.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.tools.html
@@ -160,6 +160,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -233,6 +236,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -332,6 +338,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -417,6 +426,9 @@ 
Method Details

             "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           },
@@ -508,6 +520,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -582,6 +597,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.tools.versions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.tools.versions.html
index bca3c33950..fb7d8e3c9e 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.tools.versions.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.tools.versions.html
@@ -159,6 +159,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
@@ -238,6 +241,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
@@ -343,6 +349,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
@@ -434,6 +443,9 @@ 
Method Details

               "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             },
@@ -539,6 +551,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html b/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html
index c603fdeeb6..a481bf15fe 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.agents.webhooks.html
@@ -141,6 +141,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -176,6 +179,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -225,6 +231,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -260,6 +269,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -335,6 +347,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -370,6 +385,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -431,6 +449,9 @@ 
Method Details

             "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           },
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
         "username": "A String", # The user name for HTTP Basic authentication.
@@ -466,6 +487,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -533,6 +557,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -568,6 +595,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -618,6 +648,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -653,6 +686,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
diff --git a/docs/dyn/dialogflow_v3.projects.locations.html b/docs/dyn/dialogflow_v3.projects.locations.html
index e1922b74b5..0ce5e9d198 100644
--- a/docs/dyn/dialogflow_v3.projects.locations.html
+++ b/docs/dyn/dialogflow_v3.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html
index 3f24cde975..a7812f4b7c 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html
@@ -179,6 +179,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
@@ -214,6 +217,9 @@ 
Method Details

                   "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                 },
               },
+              "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+              },
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
               "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
               "username": "A String", # The user name for HTTP Basic authentication.
@@ -6832,6 +6838,9 @@ 
Method Details

                     "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                   },
                 },
+                "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                  "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+                },
                 "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                 "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
                 "username": "A String", # The user name for HTTP Basic authentication.
@@ -6867,6 +6876,9 @@ 
Method Details

                       "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                     },
                   },
+                  "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                    "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+                  },
                   "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                   "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
                   "username": "A String", # The user name for HTTP Basic authentication.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html
index 6f9099cd27..87f65a77d6 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.html
@@ -192,6 +192,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -227,6 +230,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
@@ -393,6 +399,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -428,6 +437,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
@@ -510,6 +522,9 @@ 
Method Details

                   "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                 },
               },
+              "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+              },
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
               "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
               "username": "A String", # The user name for HTTP Basic authentication.
@@ -545,6 +560,9 @@ 
Method Details

                     "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                   },
                 },
+                "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                  "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+                },
                 "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                 "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
                 "username": "A String", # The user name for HTTP Basic authentication.
@@ -644,6 +662,9 @@ 
Method Details

                   "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                 },
               },
+              "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+              },
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
               "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
               "username": "A String", # The user name for HTTP Basic authentication.
@@ -679,6 +700,9 @@ 
Method Details

                     "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
                   },
                 },
+                "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+                  "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+                },
                 "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
                 "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
                 "username": "A String", # The user name for HTTP Basic authentication.
@@ -769,6 +793,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -804,6 +831,9 @@ 
Method Details

                 "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               },
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
             "username": "A String", # The user name for HTTP Basic authentication.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html
index 0de94c522a..86ec49c173 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.html
@@ -127,6 +127,9 @@ 
Method Details

     The object takes the form of:
 
 { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -482,6 +485,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -568,6 +574,9 @@ 
Method Details

   An object of the form:
 
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -923,6 +932,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1077,6 +1089,9 @@ 
Method Details

   An object of the form:
 
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1432,6 +1447,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1578,6 +1596,9 @@ 
Method Details

   "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
   "playbooks": [ # The list of playbooks. There will be a maximum number of items returned based on the page_size field in the request.
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+      "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+        "code": "A String", # Optional. Source code of the block in Python.
+      },
       "createTime": "A String", # Output only. The timestamp of initial playbook creation.
       "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
       "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1933,6 +1954,9 @@ 
Method Details

           },
         },
       ],
+      "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+        "A String",
+      ],
       "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
         { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
           "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2037,6 +2061,9 @@ 
Method Details

     The object takes the form of:
 
 { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2392,6 +2419,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2479,6 +2509,9 @@ 
Method Details

   An object of the form:
 
     { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.
+  "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+    "code": "A String", # Optional. Source code of the block in Python.
+  },
   "createTime": "A String", # Output only. The timestamp of initial playbook creation.
   "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
   "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2834,6 +2867,9 @@ 
Method Details

       },
     },
   ],
+  "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+    "A String",
+  ],
   "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
     { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
       "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html
index 8cc9e9a45f..3206e4e5d2 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.playbooks.versions.html
@@ -346,6 +346,9 @@ 
Method Details

   ],
   "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -701,6 +704,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1024,6 +1030,9 @@ 
Method Details

   ],
   "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -1379,6 +1388,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -1727,6 +1739,9 @@ 
Method Details

   ],
   "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2082,6 +2097,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2417,6 +2435,9 @@ 
Method Details

       ],
       "name": "A String", # The unique identifier of the playbook version. Format: `projects//locations//agents//playbooks//versions/`.
       "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # Output only. Snapshot of the playbook when the playbook version is created.
+        "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+          "code": "A String", # Optional. Source code of the block in Python.
+        },
         "createTime": "A String", # Output only. The timestamp of initial playbook creation.
         "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
         "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -2772,6 +2793,9 @@ 
Method Details

             },
           },
         ],
+        "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+          "A String",
+        ],
         "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
           { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
             "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
@@ -2890,6 +2914,9 @@ 
Method Details

 
     { # The response message for Playbooks.RestorePlaybookVersion.
   "playbook": { # Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result. # The updated playbook.
+    "codeBlock": { # Represents a code block. # Optional. The playbook's scoped code block, which may implement handlers and actions.
+      "code": "A String", # Optional. Source code of the block in Python.
+    },
     "createTime": "A String", # Output only. The timestamp of initial playbook creation.
     "displayName": "A String", # Required. The human-readable name of the playbook, unique within an agent.
     "goal": "A String", # Required. High level description of the goal the playbook intend to accomplish. A goal should be concise since it's visible to other playbooks that may reference this playbook.
@@ -3245,6 +3272,9 @@ 
Method Details

         },
       },
     ],
+    "inlineActions": [ # Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.
+      "A String",
+    ],
     "inputParameterDefinitions": [ # Optional. Defined structured input parameters for this playbook.
       { # Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.
         "description": "A String", # Human-readable description of the parameter. Limited to 300 characters.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html
index 702e3969e3..706bc6d7b1 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html
@@ -194,6 +194,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -298,6 +301,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -475,6 +481,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -591,6 +600,9 @@ 
Method Details

             "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
             "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           },
@@ -713,6 +725,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
@@ -818,6 +833,9 @@ 
Method Details

         "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       },
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.versions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.versions.html
index 5514d7a0df..ac4e81b9a8 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.versions.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.versions.html
@@ -190,6 +190,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
@@ -300,6 +303,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
@@ -436,6 +442,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
@@ -558,6 +567,9 @@ 
Method Details

               "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
               "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
             },
+            "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+              "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+            },
             "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
               "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
             },
@@ -694,6 +706,9 @@ 
Method Details

           "secretVersionForClientSecret": "A String", # Optional. The name of the SecretManager secret version resource storing the client secret. If this field is set, the `client_secret` field will be ignored. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           "tokenEndpoint": "A String", # Required. The token endpoint in the OAuth provider to exchange for an access token.
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuthConfig": { # Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). # Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth.
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         },
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html
index bf40792ade..8b72f33146 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.webhooks.html
@@ -141,6 +141,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -176,6 +179,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -225,6 +231,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -260,6 +269,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -335,6 +347,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -370,6 +385,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -431,6 +449,9 @@ 
Method Details

             "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
           },
         },
+        "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+          "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+        },
         "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
         "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
         "username": "A String", # The user name for HTTP Basic authentication.
@@ -466,6 +487,9 @@ 
Method Details

               "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
             },
           },
+          "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+            "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+          },
           "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
           "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
           "username": "A String", # The user name for HTTP Basic authentication.
@@ -533,6 +557,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -568,6 +595,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
@@ -618,6 +648,9 @@ 
Method Details

         "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
       },
     },
+    "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+      "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+    },
     "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
     "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
     "username": "A String", # The user name for HTTP Basic authentication.
@@ -653,6 +686,9 @@ 
Method Details

           "secretVersion": "A String", # Required. The SecretManager secret version resource storing the header value. Format: `projects/{project}/secrets/{secret}/versions/{version}`
         },
       },
+      "serviceAccountAuthConfig": { # Configuration for authentication using a service account. # Optional. Configuration for service account authentication.
+        "serviceAccount": "A String", # Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).
+      },
       "serviceAgentAuth": "A String", # Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.
       "uri": "A String", # Required. The webhook URI for receiving POST requests. It must use https protocol.
       "username": "A String", # The user name for HTTP Basic authentication.
diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.html
index a5426487da..32cc22f231 100644
--- a/docs/dyn/dialogflow_v3beta1.projects.locations.html
+++ b/docs/dyn/dialogflow_v3beta1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json
index ef4a0cc60f..62902e66b6 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json
@@ -4407,7 +4407,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -9258,7 +9258,7 @@
 }
 }
 },
-"revision": "20251013",
+"revision": "20251027",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -11402,6 +11402,10 @@
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -11485,6 +11489,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3WebhookRequest",
@@ -13832,6 +13847,10 @@
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -13915,6 +13934,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",
@@ -22187,7 +22217,7 @@ true
 "id": "GoogleCloudDialogflowV2ToolTLSConfigCACert",
 "properties": {
 "cert": {
-"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")",
+"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```",
 "format": "byte",
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
index a984a684c7..e79d3f228f 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json
@@ -4172,7 +4172,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -8898,7 +8898,7 @@
 }
 }
 },
-"revision": "20251013",
+"revision": "20251027",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -11042,6 +11042,10 @@
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -11125,6 +11129,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3WebhookRequest",
@@ -13472,6 +13487,10 @@
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -13555,6 +13574,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",
@@ -25059,7 +25089,7 @@ true
 "id": "GoogleCloudDialogflowV2beta1ToolTLSConfigCACert",
 "properties": {
 "cert": {
-"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\")",
+"description": "Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, Dialogflow will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with \"subject alt name\". For instance a certificate can be self-signed using the following command, ``` openssl x509 -req -days 200 -in example.com.csr \\ -signkey example.com.key \\ -out example.com.crt \\ -extfile <(printf \"\\nsubjectAltName='DNS:www.example.com'\") ```",
 "format": "byte",
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json
index 4cdfab79d1..e34e2cc294 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json
@@ -148,7 +148,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -5319,7 +5319,7 @@
 }
 }
 },
-"revision": "20250929",
+"revision": "20251027",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3Action": {
@@ -6010,6 +6010,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3CodeBlock": {
+"description": "Represents a code block.",
+"id": "GoogleCloudDialogflowCxV3CodeBlock",
+"properties": {
+"code": {
+"description": "Optional. Source code of the block in Python.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3CompareVersionsRequest": {
 "description": "The request message for Versions.CompareVersions.",
 "id": "GoogleCloudDialogflowCxV3CompareVersionsRequest",
@@ -9640,6 +9651,10 @@ false
 "description": "Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.",
 "id": "GoogleCloudDialogflowCxV3Playbook",
 "properties": {
+"codeBlock": {
+"$ref": "GoogleCloudDialogflowCxV3CodeBlock",
+"description": "Optional. The playbook's scoped code block, which may implement handlers and actions."
+},
 "createTime": {
 "description": "Output only. The timestamp of initial playbook creation.",
 "format": "google-datetime",
@@ -9661,6 +9676,14 @@ false
 },
 "type": "array"
 },
+"inlineActions": {
+"description": "Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
 "inputParameterDefinitions": {
 "description": "Optional. Defined structured input parameters for this playbook.",
 "items": {
@@ -11261,6 +11284,10 @@ false
 "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationOAuthConfig",
 "description": "Config for OAuth."
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig",
+"description": "Configuration for service account authentication."
+},
 "serviceAgentAuthConfig": {
 "$ref": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig",
 "description": "Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth."
@@ -11358,6 +11385,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig": {
 "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
 "id": "GoogleCloudDialogflowCxV3ToolAuthenticationServiceAgentAuthConfig",
@@ -12243,6 +12281,10 @@ false
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -12326,6 +12368,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3WebhookRequest",
@@ -14673,6 +14726,10 @@ false
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -14756,6 +14813,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",
diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
index 5406e20144..99093421b3 100644
--- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
+++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json
@@ -148,7 +148,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -5446,7 +5446,7 @@
 }
 }
 },
-"revision": "20251013",
+"revision": "20251027",
 "rootUrl": "https://dialogflow.googleapis.com/",
 "schemas": {
 "GoogleCloudDialogflowCxV3AdvancedSettings": {
@@ -7590,6 +7590,10 @@
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -7673,6 +7677,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3WebhookRequest",
@@ -8811,6 +8826,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1CodeBlock": {
+"description": "Represents a code block.",
+"id": "GoogleCloudDialogflowCxV3beta1CodeBlock",
+"properties": {
+"code": {
+"description": "Optional. Source code of the block in Python.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1CompareVersionsRequest": {
 "description": "The request message for Versions.CompareVersions.",
 "id": "GoogleCloudDialogflowCxV3beta1CompareVersionsRequest",
@@ -13011,6 +13037,10 @@ false
 "description": "Playbook is the basic building block to instruct the LLM how to execute a certain task. A playbook consists of a goal to accomplish, an optional list of step by step instructions (the step instruction may refers to name of the custom or default plugin tools to use) to perform the task, a list of contextual input data to be passed in at the beginning of the invoked, and a list of output parameters to store the playbook result.",
 "id": "GoogleCloudDialogflowCxV3beta1Playbook",
 "properties": {
+"codeBlock": {
+"$ref": "GoogleCloudDialogflowCxV3beta1CodeBlock",
+"description": "Optional. The playbook's scoped code block, which may implement handlers and actions."
+},
 "createTime": {
 "description": "Output only. The timestamp of initial playbook creation.",
 "format": "google-datetime",
@@ -13032,6 +13062,14 @@ false
 },
 "type": "array"
 },
+"inlineActions": {
+"description": "Optional. Output only. Names of inline actions scoped to this playbook. These actions are in addition to those belonging to referenced tools, child playbooks, and flows, e.g. actions that are defined in the playbook's code block.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
 "inputParameterDefinitions": {
 "description": "Optional. Defined structured input parameters for this playbook.",
 "items": {
@@ -14755,6 +14793,10 @@ false
 "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationOAuthConfig",
 "description": "Config for OAuth."
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig",
+"description": "Configuration for service account authentication."
+},
 "serviceAgentAuthConfig": {
 "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig",
 "description": "Config for [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent) auth."
@@ -14852,6 +14894,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the tool call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the tool request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig": {
 "description": "Config for auth using [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
 "id": "GoogleCloudDialogflowCxV3beta1ToolAuthenticationServiceAgentAuthConfig",
@@ -15922,6 +15975,10 @@ false
 "description": "Optional. The HTTP request headers to send together with webhook requests. Header values are stored in SecretManager secret versions. When the same header name is specified in both `request_headers` and `secret_versions_for_request_headers`, the value in `secret_versions_for_request_headers` will be used.",
 "type": "object"
 },
+"serviceAccountAuthConfig": {
+"$ref": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"description": "Optional. Configuration for service account authentication."
+},
 "serviceAgentAuth": {
 "description": "Optional. Indicate the auth token type generated from the [Diglogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent). The generated token is sent in the Authorization header.",
 "enum": [
@@ -16005,6 +16062,17 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig": {
+"description": "Configuration for authentication using a service account.",
+"id": "GoogleCloudDialogflowCxV3beta1WebhookGenericWebServiceServiceAccountAuthConfig",
+"properties": {
+"serviceAccount": {
+"description": "Required. The email address of the service account used to authenticate the webhook call. Dialogflow uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the webhook request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the [Dialogflow service agent](https://cloud.google.com/iam/docs/service-agents#dialogflow-service-agent).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDialogflowCxV3beta1WebhookRequest": {
 "description": "The request message for a webhook call. The request is sent as a JSON object and the field names will be presented in camel cases. You may see undocumented fields in an actual request. These fields are used internally by Dialogflow and should be ignored.",
 "id": "GoogleCloudDialogflowCxV3beta1WebhookRequest",

From 0a0ffefd477c00e649e2449de4e978e97c7cb77e Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:13 +0000
Subject: [PATCH 31/70] feat(discoveryengine): update the api

#### discoveryengine:v1

The following keys were added:
- resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.dataStores.resources.servingConfigs.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.dataStores.resources.servingConfigs.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.userStores.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.userStores.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.userStores.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.userStores.methods.patch (Total Keys: 15)
- schemas.GoogleCloudDiscoveryengineV1DataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1ListServingConfigsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1Project.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1UserStore (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaProject.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1betaProject.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaUserStore (Total Keys: 7)

#### discoveryengine:v1alpha

The following keys were deleted:
- schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.experimentalFeatures (Total Keys: 2)

The following keys were added:
- resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.distributeLicenseConfig (Total Keys: 12)
- resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.get (Total Keys: 11)
- resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.list (Total Keys: 16)
- resources.billingAccounts.resources.billingAccountLicenseConfigs.methods.retractLicenseConfig (Total Keys: 12)
- resources.media.methods.upload (Total Keys: 16)
- resources.projects.resources.locations.resources.authorizations.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.authorizations.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.authorizations.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.authorizations.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.authorizations.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.collections.resources.dataStores.resources.widgetConfigs.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.list (Total Keys: 18)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.agents.resources.files.methods.import (Total Keys: 12)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.list (Total Keys: 18)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.assistants.resources.cannedQueries.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.collections.resources.engines.resources.widgetConfigs.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.dataStores.resources.widgetConfigs.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.userStores.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.userStores.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.userStores.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.userStores.methods.patch (Total Keys: 15)
- schemas.GoogleCloudDiscoveryengineV1DataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1Project.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1UserStore (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaAgent (Total Keys: 39)
- schemas.GoogleCloudDiscoveryengineV1alphaAuthorization (Total Keys: 18)
- schemas.GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig (Total Keys: 19)
- schemas.GoogleCloudDiscoveryengineV1alphaCannedQuery (Total Keys: 23)
- schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaListAgentsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaProject.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1alphaUserStore (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.geminiBundle (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1betaProject.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaUserStore (Total Keys: 7)

#### discoveryengine:v1beta

The following keys were added:
- resources.projects.resources.locations.resources.userStores.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.userStores.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.userStores.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.userStores.methods.patch (Total Keys: 15)
- schemas.GoogleCloudDiscoveryengineV1DataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1Project.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1UserStore (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1alphaDataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1alphaProject.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaDataStore.properties.configurableBillingApproachUpdateTime (Total Keys: 3)
- schemas.GoogleCloudDiscoveryengineV1betaProject.properties.configurableBillingStatus (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig.properties.optOutNotebookSharing.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaUserStore (Total Keys: 7)
---
 ...llections.dataStores.completionConfig.html |    2 +-
 ...ects.locations.collections.dataStores.html |    7 +-
 ...collections.dataStores.servingConfigs.html |  252 ++-
 ....collections.engines.completionConfig.html |    2 +-
 ...ns.collections.engines.servingConfigs.html |  252 ++-
 ...locations.dataStores.completionConfig.html |    2 +-
 ...gine_v1.projects.locations.dataStores.html |    7 +-
 ...s.locations.dataStores.servingConfigs.html |  252 ++-
 ...gine_v1.projects.locations.userStores.html |  140 ++
 ...Accounts.billingAccountLicenseConfigs.html |  335 +++
 ...scoveryengine_v1alpha.billingAccounts.html |   91 +
 docs/dyn/discoveryengine_v1alpha.html         |    5 +
 docs/dyn/discoveryengine_v1alpha.media.html   |  505 +++++
 .../dyn/discoveryengine_v1alpha.projects.html |   24 +
 ...pha.projects.locations.authorizations.html |  295 +++
 ...llections.dataStores.completionConfig.html |    2 +-
 ...ects.locations.collections.dataStores.html |    7 +-
 ...collections.dataStores.servingConfigs.html |    4 +-
 ....collections.dataStores.widgetConfigs.html |  457 +++-
 ...tions.engines.assistants.agents.files.html |  120 ++
 ...collections.engines.assistants.agents.html |  473 +++++
 ...ions.engines.assistants.cannedQueries.html |  404 ++++
 ...ations.collections.engines.assistants.html |   10 +
 ....collections.engines.completionConfig.html |    2 +-
 ...ns.collections.engines.servingConfigs.html |    4 +-
 ...ons.collections.engines.widgetConfigs.html |  457 +++-
 ...locations.dataStores.completionConfig.html |    2 +-
 ...v1alpha.projects.locations.dataStores.html |    7 +-
 ...s.locations.dataStores.servingConfigs.html |    4 +-
 ...ts.locations.dataStores.widgetConfigs.html |  457 +++-
 ...1alpha.projects.locations.evaluations.html |    6 +-
 ...veryengine_v1alpha.projects.locations.html |    5 +
 ...v1alpha.projects.locations.userStores.html |  140 ++
 ...llections.dataStores.completionConfig.html |    2 +-
 ...ects.locations.collections.dataStores.html |    7 +-
 ...collections.dataStores.servingConfigs.html |    4 +-
 ....collections.engines.completionConfig.html |    2 +-
 ...ns.collections.engines.servingConfigs.html |    4 +-
 ...locations.dataStores.completionConfig.html |    2 +-
 ..._v1beta.projects.locations.dataStores.html |    7 +-
 ...s.locations.dataStores.servingConfigs.html |    4 +-
 ...v1beta.projects.locations.evaluations.html |    6 +-
 ..._v1beta.projects.locations.userStores.html |  140 ++
 .../documents/discoveryengine.v1.json         |  541 ++++-
 .../documents/discoveryengine.v1alpha.json    | 1875 ++++++++++++++++-
 .../documents/discoveryengine.v1beta.json     |  332 ++-
 46 files changed, 7583 insertions(+), 75 deletions(-)
 create mode 100644 docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html
 create mode 100644 docs/dyn/discoveryengine_v1alpha.billingAccounts.html
 create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html
 create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.files.html
 create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html
 create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.cannedQueries.html

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html
index 67be70e900..d618da548d 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.completionConfig.html
@@ -124,7 +124,7 @@ 
Method Details

     "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
     "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
index f9d3315a38..2d98a88e2e 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.html
@@ -189,7 +189,7 @@ 
Method Details

   includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
   query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
   queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
-  userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  userPseudoId: string, Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -249,6 +249,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -460,6 +461,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -627,6 +629,7 @@ 
Method Details

         "state": "A String", # Output only. The states of the CmekConfig.
       },
       "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+      "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
       "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
       "createTime": "A String", # Output only. Timestamp the DataStore was created at.
       "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -782,6 +785,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -919,6 +923,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
index eb303bd261..eb3c735755 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
@@ -80,6 +80,15 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  get(name, x__xgafv=None)

+
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

+

+  list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all ServingConfigs linked to this dataStore.

+

+  list_next()

+
Retrieves the next page of results.

 

   patch(name, body=None, updateMask=None, x__xgafv=None)

 
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

@@ -684,6 +693,245 @@ 
Method Details

   
Close httplib2 connections.

 
 
+

+    get(name, x__xgafv=None)
+  
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
+
+Args:
+  name: string, Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  "answerGenerationSpec": { # The specification for answer generation. # Optional. The specification for answer generation.
+    "userDefinedClassifierSpec": { # The specification for user defined classifier. # Optional. The specification for user specified classifier spec.
+      "enableUserDefinedClassifier": True or False, # Optional. Whether or not to enable and include user defined classifier.
+      "modelId": "A String", # Optional. The model id to be used for the user defined classifier.
+      "preamble": "A String", # Optional. The preamble to be used for the user defined classifier.
+      "seed": 42, # Optional. The seed value to be used for the user defined classifier.
+      "taskMarker": "A String", # Optional. The task marker to be used for the user defined classifier.
+      "temperature": 3.14, # Optional. The temperature value to be used for the user defined classifier.
+      "topK": "A String", # Optional. The top-k value to be used for the user defined classifier.
+      "topP": 3.14, # Optional. The top-p value to be used for the user defined classifier.
+    },
+  },
+  "boostControlIds": [ # 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.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. ServingConfig created timestamp.
+  "displayName": "A String", # 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.
+  "dissociateControlIds": [ # 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.
+    "A String",
+  ],
+  "diversityLevel": "A String", # 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.
+  "filterControlIds": [ # 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.
+    "A String",
+  ],
+  "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration.
+    "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store.
+      "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+        "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+        "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+      },
+      "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+        "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+        "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+        "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+        "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+        "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+      },
+      "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+      "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+        "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+        "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+        "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+      },
+      "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+        "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+        "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+        "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+        "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+        "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+        "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+        "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+          "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+        },
+        "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+          "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+        },
+        "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+        "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+      },
+    },
+  },
+  "ignoreControlIds": [ # 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.
+    "A String",
+  ],
+  "mediaConfig": { # 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. # The MediaConfig of the serving configuration.
+    "contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
+    "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
+    "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion.
+    "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.
+    "demotionEventType": "A String", # 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.
+  },
+  "modelId": "A String", # 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.
+  "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+  "onewaySynonymsControlIds": [ # 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.
+    "A String",
+  ],
+  "promoteControlIds": [ # Condition promote specifications. Maximum number of specifications is 100.
+    "A String",
+  ],
+  "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+  "redirectControlIds": [ # 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.
+    "A String",
+  ],
+  "replacementControlIds": [ # 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.
+    "A String",
+  ],
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that a serving config can be associated with.
+  "synonymsControlIds": [ # 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.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. ServingConfig updated timestamp.
+}

+

+
+

+    list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all ServingConfigs linked to this dataStore.
+
+Args:
+  parent: string, Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` (required)
+  pageSize: integer, 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.
+  pageToken: string, Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListServingConfigs method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "servingConfigs": [ # All the ServingConfigs for a given dataStore.
+    { # 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.
+      "answerGenerationSpec": { # The specification for answer generation. # Optional. The specification for answer generation.
+        "userDefinedClassifierSpec": { # The specification for user defined classifier. # Optional. The specification for user specified classifier spec.
+          "enableUserDefinedClassifier": True or False, # Optional. Whether or not to enable and include user defined classifier.
+          "modelId": "A String", # Optional. The model id to be used for the user defined classifier.
+          "preamble": "A String", # Optional. The preamble to be used for the user defined classifier.
+          "seed": 42, # Optional. The seed value to be used for the user defined classifier.
+          "taskMarker": "A String", # Optional. The task marker to be used for the user defined classifier.
+          "temperature": 3.14, # Optional. The temperature value to be used for the user defined classifier.
+          "topK": "A String", # Optional. The top-k value to be used for the user defined classifier.
+          "topP": 3.14, # Optional. The top-p value to be used for the user defined classifier.
+        },
+      },
+      "boostControlIds": [ # 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.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. ServingConfig created timestamp.
+      "displayName": "A String", # 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.
+      "dissociateControlIds": [ # 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.
+        "A String",
+      ],
+      "diversityLevel": "A String", # 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.
+      "filterControlIds": [ # 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.
+        "A String",
+      ],
+      "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration.
+        "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store.
+          "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+            "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+            "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+          },
+          "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+            "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+            "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+            "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+            "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+            "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+          },
+          "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+          "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+            "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+            "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+            "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+          },
+          "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+            "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+            "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+            "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+            "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+            "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+            "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+            "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+              "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+            },
+            "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+              "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+            },
+            "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+            "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+          },
+        },
+      },
+      "ignoreControlIds": [ # 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.
+        "A String",
+      ],
+      "mediaConfig": { # 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. # The MediaConfig of the serving configuration.
+        "contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
+        "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
+        "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion.
+        "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.
+        "demotionEventType": "A String", # 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.
+      },
+      "modelId": "A String", # 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.
+      "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+      "onewaySynonymsControlIds": [ # 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.
+        "A String",
+      ],
+      "promoteControlIds": [ # Condition promote specifications. Maximum number of specifications is 100.
+        "A String",
+      ],
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "redirectControlIds": [ # 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.
+        "A String",
+      ],
+      "replacementControlIds": [ # 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.
+        "A String",
+      ],
+      "solutionType": "A String", # Required. Immutable. Specifies the solution type that a serving config can be associated with.
+      "synonymsControlIds": [ # 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.
+        "A String",
+      ],
+      "updateTime": "A String", # Output only. ServingConfig updated timestamp.
+    },
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
 

     patch(name, body=None, updateMask=None, x__xgafv=None)
   
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
@@ -1278,7 +1526,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
@@ -1677,7 +1925,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html
index 9bf2e3d22c..0042565648 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.completionConfig.html
@@ -124,7 +124,7 @@ 
Method Details

     "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
     "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
index 351de87369..582b65cfa4 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
@@ -80,6 +80,15 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  get(name, x__xgafv=None)

+
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

+

+  list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all ServingConfigs linked to this dataStore.

+

+  list_next()

+
Retrieves the next page of results.

 

   patch(name, body=None, updateMask=None, x__xgafv=None)

 
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

@@ -684,6 +693,245 @@ 
Method Details

   
Close httplib2 connections.

 

 
+

+    get(name, x__xgafv=None)
+  
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
+
+Args:
+  name: string, Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  "answerGenerationSpec": { # The specification for answer generation. # Optional. The specification for answer generation.
+    "userDefinedClassifierSpec": { # The specification for user defined classifier. # Optional. The specification for user specified classifier spec.
+      "enableUserDefinedClassifier": True or False, # Optional. Whether or not to enable and include user defined classifier.
+      "modelId": "A String", # Optional. The model id to be used for the user defined classifier.
+      "preamble": "A String", # Optional. The preamble to be used for the user defined classifier.
+      "seed": 42, # Optional. The seed value to be used for the user defined classifier.
+      "taskMarker": "A String", # Optional. The task marker to be used for the user defined classifier.
+      "temperature": 3.14, # Optional. The temperature value to be used for the user defined classifier.
+      "topK": "A String", # Optional. The top-k value to be used for the user defined classifier.
+      "topP": 3.14, # Optional. The top-p value to be used for the user defined classifier.
+    },
+  },
+  "boostControlIds": [ # 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.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. ServingConfig created timestamp.
+  "displayName": "A String", # 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.
+  "dissociateControlIds": [ # 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.
+    "A String",
+  ],
+  "diversityLevel": "A String", # 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.
+  "filterControlIds": [ # 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.
+    "A String",
+  ],
+  "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration.
+    "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store.
+      "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+        "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+        "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+      },
+      "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+        "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+        "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+        "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+        "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+        "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+      },
+      "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+      "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+        "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+        "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+        "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+      },
+      "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+        "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+        "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+        "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+        "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+        "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+        "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+        "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+          "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+        },
+        "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+          "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+        },
+        "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+        "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+      },
+    },
+  },
+  "ignoreControlIds": [ # 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.
+    "A String",
+  ],
+  "mediaConfig": { # 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. # The MediaConfig of the serving configuration.
+    "contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
+    "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
+    "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion.
+    "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.
+    "demotionEventType": "A String", # 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.
+  },
+  "modelId": "A String", # 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.
+  "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+  "onewaySynonymsControlIds": [ # 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.
+    "A String",
+  ],
+  "promoteControlIds": [ # Condition promote specifications. Maximum number of specifications is 100.
+    "A String",
+  ],
+  "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+  "redirectControlIds": [ # 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.
+    "A String",
+  ],
+  "replacementControlIds": [ # 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.
+    "A String",
+  ],
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that a serving config can be associated with.
+  "synonymsControlIds": [ # 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.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. ServingConfig updated timestamp.
+}

+

+
+

+    list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all ServingConfigs linked to this dataStore.
+
+Args:
+  parent: string, Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` (required)
+  pageSize: integer, 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.
+  pageToken: string, Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListServingConfigs method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "servingConfigs": [ # All the ServingConfigs for a given dataStore.
+    { # 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.
+      "answerGenerationSpec": { # The specification for answer generation. # Optional. The specification for answer generation.
+        "userDefinedClassifierSpec": { # The specification for user defined classifier. # Optional. The specification for user specified classifier spec.
+          "enableUserDefinedClassifier": True or False, # Optional. Whether or not to enable and include user defined classifier.
+          "modelId": "A String", # Optional. The model id to be used for the user defined classifier.
+          "preamble": "A String", # Optional. The preamble to be used for the user defined classifier.
+          "seed": 42, # Optional. The seed value to be used for the user defined classifier.
+          "taskMarker": "A String", # Optional. The task marker to be used for the user defined classifier.
+          "temperature": 3.14, # Optional. The temperature value to be used for the user defined classifier.
+          "topK": "A String", # Optional. The top-k value to be used for the user defined classifier.
+          "topP": 3.14, # Optional. The top-p value to be used for the user defined classifier.
+        },
+      },
+      "boostControlIds": [ # 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.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. ServingConfig created timestamp.
+      "displayName": "A String", # 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.
+      "dissociateControlIds": [ # 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.
+        "A String",
+      ],
+      "diversityLevel": "A String", # 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.
+      "filterControlIds": [ # 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.
+        "A String",
+      ],
+      "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration.
+        "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store.
+          "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+            "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+            "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+          },
+          "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+            "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+            "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+            "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+            "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+            "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+          },
+          "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+          "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+            "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+            "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+            "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+          },
+          "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+            "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+            "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+            "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+            "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+            "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+            "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+            "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+              "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+            },
+            "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+              "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+            },
+            "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+            "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+          },
+        },
+      },
+      "ignoreControlIds": [ # 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.
+        "A String",
+      ],
+      "mediaConfig": { # 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. # The MediaConfig of the serving configuration.
+        "contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
+        "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
+        "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion.
+        "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.
+        "demotionEventType": "A String", # 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.
+      },
+      "modelId": "A String", # 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.
+      "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+      "onewaySynonymsControlIds": [ # 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.
+        "A String",
+      ],
+      "promoteControlIds": [ # Condition promote specifications. Maximum number of specifications is 100.
+        "A String",
+      ],
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "redirectControlIds": [ # 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.
+        "A String",
+      ],
+      "replacementControlIds": [ # 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.
+        "A String",
+      ],
+      "solutionType": "A String", # Required. Immutable. Specifies the solution type that a serving config can be associated with.
+      "synonymsControlIds": [ # 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.
+        "A String",
+      ],
+      "updateTime": "A String", # Output only. ServingConfig updated timestamp.
+    },
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
 

     patch(name, body=None, updateMask=None, x__xgafv=None)
   
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
@@ -1278,7 +1526,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
@@ -1677,7 +1925,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html
index 74429d29e6..b6d8dc7714 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.completionConfig.html
@@ -124,7 +124,7 @@ 
Method Details

     "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
     "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
index 20c1569318..a1b3e5dc4c 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.html
@@ -181,7 +181,7 @@ 
Method Details

   includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
   query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
   queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
-  userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  userPseudoId: string, Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -241,6 +241,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -452,6 +453,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -619,6 +621,7 @@ 
Method Details

         "state": "A String", # Output only. The states of the CmekConfig.
       },
       "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+      "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
       "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
       "createTime": "A String", # Output only. Timestamp the DataStore was created at.
       "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -774,6 +777,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -911,6 +915,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
index f0c6fee9fb..edb904738c 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
@@ -80,6 +80,15 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  get(name, x__xgafv=None)

+
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

+

+  list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all ServingConfigs linked to this dataStore.

+

+  list_next()

+
Retrieves the next page of results.

 

   patch(name, body=None, updateMask=None, x__xgafv=None)

 
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.

@@ -684,6 +693,245 @@ 
Method Details

   
Close httplib2 connections.

 

 
+

+    get(name, x__xgafv=None)
+  
Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
+
+Args:
+  name: string, Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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.
+  "answerGenerationSpec": { # The specification for answer generation. # Optional. The specification for answer generation.
+    "userDefinedClassifierSpec": { # The specification for user defined classifier. # Optional. The specification for user specified classifier spec.
+      "enableUserDefinedClassifier": True or False, # Optional. Whether or not to enable and include user defined classifier.
+      "modelId": "A String", # Optional. The model id to be used for the user defined classifier.
+      "preamble": "A String", # Optional. The preamble to be used for the user defined classifier.
+      "seed": 42, # Optional. The seed value to be used for the user defined classifier.
+      "taskMarker": "A String", # Optional. The task marker to be used for the user defined classifier.
+      "temperature": 3.14, # Optional. The temperature value to be used for the user defined classifier.
+      "topK": "A String", # Optional. The top-k value to be used for the user defined classifier.
+      "topP": 3.14, # Optional. The top-p value to be used for the user defined classifier.
+    },
+  },
+  "boostControlIds": [ # 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.
+    "A String",
+  ],
+  "createTime": "A String", # Output only. ServingConfig created timestamp.
+  "displayName": "A String", # 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.
+  "dissociateControlIds": [ # 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.
+    "A String",
+  ],
+  "diversityLevel": "A String", # 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.
+  "filterControlIds": [ # 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.
+    "A String",
+  ],
+  "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration.
+    "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store.
+      "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+        "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+        "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+      },
+      "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+        "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+        "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+        "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+        "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+        "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+      },
+      "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+      "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+        "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+        "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+        "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+      },
+      "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+        "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+        "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+        "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+        "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+        "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+        "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+        "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+          "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+        },
+        "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+          "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+        },
+        "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+        "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+      },
+    },
+  },
+  "ignoreControlIds": [ # 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.
+    "A String",
+  ],
+  "mediaConfig": { # 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. # The MediaConfig of the serving configuration.
+    "contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
+    "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
+    "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion.
+    "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.
+    "demotionEventType": "A String", # 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.
+  },
+  "modelId": "A String", # 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.
+  "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+  "onewaySynonymsControlIds": [ # 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.
+    "A String",
+  ],
+  "promoteControlIds": [ # Condition promote specifications. Maximum number of specifications is 100.
+    "A String",
+  ],
+  "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+  "redirectControlIds": [ # 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.
+    "A String",
+  ],
+  "replacementControlIds": [ # 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.
+    "A String",
+  ],
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that a serving config can be associated with.
+  "synonymsControlIds": [ # 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.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. ServingConfig updated timestamp.
+}

+

+
+

+    list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all ServingConfigs linked to this dataStore.
+
+Args:
+  parent: string, Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` (required)
+  pageSize: integer, 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.
+  pageToken: string, Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ListServingConfigs method.
+  "nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
+  "servingConfigs": [ # All the ServingConfigs for a given dataStore.
+    { # 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.
+      "answerGenerationSpec": { # The specification for answer generation. # Optional. The specification for answer generation.
+        "userDefinedClassifierSpec": { # The specification for user defined classifier. # Optional. The specification for user specified classifier spec.
+          "enableUserDefinedClassifier": True or False, # Optional. Whether or not to enable and include user defined classifier.
+          "modelId": "A String", # Optional. The model id to be used for the user defined classifier.
+          "preamble": "A String", # Optional. The preamble to be used for the user defined classifier.
+          "seed": 42, # Optional. The seed value to be used for the user defined classifier.
+          "taskMarker": "A String", # Optional. The task marker to be used for the user defined classifier.
+          "temperature": 3.14, # Optional. The temperature value to be used for the user defined classifier.
+          "topK": "A String", # Optional. The top-k value to be used for the user defined classifier.
+          "topP": 3.14, # Optional. The top-p value to be used for the user defined classifier.
+        },
+      },
+      "boostControlIds": [ # 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.
+        "A String",
+      ],
+      "createTime": "A String", # Output only. ServingConfig created timestamp.
+      "displayName": "A String", # 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.
+      "dissociateControlIds": [ # 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.
+        "A String",
+      ],
+      "diversityLevel": "A String", # 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.
+      "filterControlIds": [ # 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.
+        "A String",
+      ],
+      "genericConfig": { # Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. # The GenericConfig of the serving configuration.
+        "contentSearchSpec": { # A specification for configuring the behavior of content search. # Specifies the expected behavior of content search. Only valid for content-search enabled data store.
+          "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+            "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+            "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+          },
+          "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+            "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+            "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+            "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+            "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+            "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+          },
+          "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+          "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+            "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+            "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+            "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+          },
+          "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+            "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+            "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+            "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+            "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+            "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+            "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+            "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+              "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+            },
+            "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+              "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+            },
+            "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+            "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+          },
+        },
+      },
+      "ignoreControlIds": [ # 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.
+        "A String",
+      ],
+      "mediaConfig": { # 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. # The MediaConfig of the serving configuration.
+        "contentFreshnessCutoffDays": 42, # Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
+        "contentWatchedPercentageThreshold": 3.14, # Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
+        "contentWatchedSecondsThreshold": 3.14, # Specifies the content watched minutes threshold for demotion.
+        "demoteContentWatchedPastDays": 42, # Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.
+        "demotionEventType": "A String", # 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.
+      },
+      "modelId": "A String", # 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.
+      "name": "A String", # Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
+      "onewaySynonymsControlIds": [ # 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.
+        "A String",
+      ],
+      "promoteControlIds": [ # Condition promote specifications. Maximum number of specifications is 100.
+        "A String",
+      ],
+      "rankingExpression": "A String", # The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
+      "redirectControlIds": [ # 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.
+        "A String",
+      ],
+      "replacementControlIds": [ # 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.
+        "A String",
+      ],
+      "solutionType": "A String", # Required. Immutable. Specifies the solution type that a serving config can be associated with.
+      "synonymsControlIds": [ # 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.
+        "A String",
+      ],
+      "updateTime": "A String", # Output only. ServingConfig updated timestamp.
+    },
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
 

     patch(name, body=None, updateMask=None, x__xgafv=None)
   
Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
@@ -1278,7 +1526,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
@@ -1677,7 +1925,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.userStores.html b/docs/dyn/discoveryengine_v1.projects.locations.userStores.html
index 278f7564c6..02264cb903 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.userStores.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.userStores.html
@@ -85,6 +85,18 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  create(parent, body=None, userStoreId=None, x__xgafv=None)

+
Creates a new User Store.

+

+  delete(name, x__xgafv=None)

+
Deletes the User Store.

+

+  get(name, x__xgafv=None)

+
Gets the User Store.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Updates the User Store.

 
Method Details

 

     batchUpdateUserLicenses(parent, body=None, x__xgafv=None)
@@ -147,4 +159,132 @@ 
Method Details

   
Close httplib2 connections.

 

 
+

+    create(parent, body=None, userStoreId=None, x__xgafv=None)
+  
Creates a new User Store.
+
+Args:
+  parent: string, Required. The parent collection resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  userStoreId: string, Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}

+

+
+

+    delete(name, x__xgafv=None)
+  
Deletes the User Store.
+
+Args:
+  name: string, Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets the User Store.
+
+Args:
+  name: string, Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}

+

+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates the User Store.
+
+Args:
+  name: string, Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}

+

+
 
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html b/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html
new file mode 100644
index 0000000000..7015c72809
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1alpha.billingAccounts.billingAccountLicenseConfigs.html
@@ -0,0 +1,335 @@
+
+
+
+
Discovery Engine API . billingAccounts . billingAccountLicenseConfigs

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)

+
Distributes a LicenseConfig from billing account level to project level.

+

+  get(name, x__xgafv=None)

+
Gets a BillingAccountLicenseConfig.

+

+  list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all BillingAccountLicenseConfigs for a given billing account.

+

+  list_next()

+
Retrieves the next page of results.

+

+  retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)

+
This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    distributeLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)
+  
Distributes a LicenseConfig from billing account level to project level.
+
+Args:
+  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LicenseConfigService.DistributeLicenseConfig method.
+  "licenseConfigId": "A String", # Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
+  "licenseCount": "A String", # Required. The number of licenses to distribute.
+  "location": "A String", # Required. The target GCP project region to distribute the license config to.
+  "projectNumber": "A String", # Required. The target GCP project number to distribute the license config to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for LicenseConfigService.DistributeLicenseConfig method.
+  "licenseConfig": { # Information about users' licenses. # The updated or created LicenseConfig.
+    "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+      "alertEnrollments": [ # Optional. The enrollment state of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+          "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+            "a_key": "A String",
+          },
+        },
+      ],
+      "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+      "contactDetails": [ # Optional. The contact details for each alert policy.
+        { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+          "emailAddress": "A String", # Optional. The email address of the contact.
+        },
+      ],
+      "languageCode": "A String", # Optional. The language code used for notifications
+    },
+    "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+    "endDate": { # 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 # Optional. The planed end date.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+    "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
+    "licenseCount": "A String", # Required. Number of licenses purchased.
+    "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+    "startDate": { # 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 # Required. The start date.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "state": "A String", # Output only. The state of the license config.
+    "subscriptionTerm": "A String", # Required. Subscription term.
+    "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+  },
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets a BillingAccountLicenseConfig.
+
+Args:
+  name: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about license configs at billing account level.
+  "autoRenew": True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
+  "endDate": { # 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 # Optional. The planed subscription end date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "geminiBundle": True or False, # Whether the license config is for Gemini bundle.
+  "licenseConfigDistributions": { # A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.
+    "a_key": "A String",
+  },
+  "licenseCount": "A String", # Required. The number of licenses purchased under this billing account license config.
+  "name": "A String", # Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.
+  "procurementEntitlementId": "A String", # The procurement entitlement id of the subscription.
+  "startDate": { # 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 # Required. The subscription start date.
+    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+  },
+  "state": "A String", # Output only. The state of the BillingAccountLicenseConfig.
+  "subscriptionDisplayName": "A String", # The subscription display name.
+  "subscriptionName": "A String", # Output only. The corresponding SubV3 subscription name.
+  "subscriptionTerm": "A String", # Required. The subscription term.
+  "subscriptionTier": "A String", # Required. The subscription tier.
+}

+

+
+

+    list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all BillingAccountLicenseConfigs for a given billing account.
+
+Args:
+  parent: string, Required. Format: `billingAccounts/{billing_account}`. (required)
+  pageSize: integer, Optional. Not supported.
+  pageToken: string, Optional. Not supported.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.
+  "billingAccountLicenseConfigs": [ # All BillingAccountLicenseConfigs for the given billing account.
+    { # Information about license configs at billing account level.
+      "autoRenew": True or False, # Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
+      "endDate": { # 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 # Optional. The planed subscription end date.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "geminiBundle": True or False, # Whether the license config is for Gemini bundle.
+      "licenseConfigDistributions": { # A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.
+        "a_key": "A String",
+      },
+      "licenseCount": "A String", # Required. The number of licenses purchased under this billing account license config.
+      "name": "A String", # Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.
+      "procurementEntitlementId": "A String", # The procurement entitlement id of the subscription.
+      "startDate": { # 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 # Required. The subscription start date.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "state": "A String", # Output only. The state of the BillingAccountLicenseConfig.
+      "subscriptionDisplayName": "A String", # The subscription display name.
+      "subscriptionName": "A String", # Output only. The corresponding SubV3 subscription name.
+      "subscriptionTerm": "A String", # Required. The subscription term.
+      "subscriptionTier": "A String", # Required. The subscription tier.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    retractLicenseConfig(billingAccountLicenseConfig, body=None, x__xgafv=None)
+  
This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
+
+Args:
+  billingAccountLicenseConfig: string, Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for LicenseConfigService.RetractLicenseConfig method.
+  "fullRetract": True or False, # Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
+  "licenseConfig": "A String", # Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.
+  "licenseCount": "A String", # Optional. The number of licenses to retract. Only used when full_retract is false.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for LicenseConfigService.RetractLicenseConfig method.
+  "licenseConfig": { # Information about users' licenses. # The updated LicenseConfig.
+    "alertPolicyResourceConfig": { # The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate. # Optional. The alert policy config for this license config.
+      "alertEnrollments": [ # Optional. The enrollment state of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+          "notificationParams": { # Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.
+            "a_key": "A String",
+          },
+        },
+      ],
+      "alertPolicy": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+      "contactDetails": [ # Optional. The contact details for each alert policy.
+        { # The contact info stored in resource level. If both project level and resource level is populated, the resource level contact info will override the project level contact info.
+          "emailAddress": "A String", # Optional. The email address of the contact.
+        },
+      ],
+      "languageCode": "A String", # Optional. The language code used for notifications
+    },
+    "autoRenew": True or False, # Optional. Whether the license config should be auto renewed when it reaches the end date.
+    "endDate": { # 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 # Optional. The planed end date.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "freeTrial": True or False, # Optional. Whether the license config is for free trial.
+    "geminiBundle": True or False, # Output only. Whether the license config is for Gemini bundle.
+    "licenseCount": "A String", # Required. Number of licenses purchased.
+    "name": "A String", # Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`
+    "startDate": { # 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 # Required. The start date.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "state": "A String", # Output only. The state of the license config.
+    "subscriptionTerm": "A String", # Required. Subscription term.
+    "subscriptionTier": "A String", # Required. Subscription tier information for the license config.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.billingAccounts.html b/docs/dyn/discoveryengine_v1alpha.billingAccounts.html
new file mode 100644
index 0000000000..cbd723c039
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1alpha.billingAccounts.html
@@ -0,0 +1,91 @@
+
+
+
+
Discovery Engine API . billingAccounts

+
Instance Methods

+

+  billingAccountLicenseConfigs()
+

+
Returns the billingAccountLicenseConfigs Resource.

+
+

+  close()

+
Close httplib2 connections.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.html b/docs/dyn/discoveryengine_v1alpha.html
index a96d73a7d9..b933dfc3a7 100644
--- a/docs/dyn/discoveryengine_v1alpha.html
+++ b/docs/dyn/discoveryengine_v1alpha.html
@@ -74,6 +74,11 @@
 
 
Discovery Engine API

 
Instance Methods

+

+  billingAccounts()
+

+
Returns the billingAccounts Resource.

+
 

   media()
 

diff --git a/docs/dyn/discoveryengine_v1alpha.media.html b/docs/dyn/discoveryengine_v1alpha.media.html
index cb2daa4aab..4cc70f0113 100644
--- a/docs/dyn/discoveryengine_v1alpha.media.html
+++ b/docs/dyn/discoveryengine_v1alpha.media.html
@@ -83,6 +83,9 @@ 
Instance Methods

 

   download_media(name, fileId=None, viewId=None, x__xgafv=None)

 
Downloads a file from the session.

+

+  upload(name, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+
Uploads a file for the assistant to use as a source of information within the session.

 
Method Details

 

     close()
@@ -351,4 +354,506 @@ 
Method Details

     

 

 
+

+    upload(name, body=None, media_body=None, media_mime_type=None, x__xgafv=None)
+  
Uploads a file for the assistant to use as a source of information within the session.
+
+Args:
+  name: string, Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the AssistantService.UploadSessionFile method.
+  "blob": { # A reference to data stored on the filesystem, on GFS or in blobstore. # Information about the file being uploaded.
+    "algorithm": "A String", # Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
+    "bigstoreObjectRef": "A String", # Use object_id instead.
+    "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+    "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+      "blobGeneration": "A String", # The blob generation id.
+      "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+      "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+      "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+      "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+    },
+    "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
+      { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+    ],
+    "contentType": "A String", # MIME type of the data
+    "contentTypeInfo": { # Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. # Extended content type information provided for Scotty uploads.
+      "bestGuess": "A String", # Scotty's best guess of what the content type of the file is.
+      "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
+      "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client.
+      "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
+      "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
+    },
+    "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+    "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
+    "diffChecksumsResponse": { # Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
+      "checksumsLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+      "chunkSizeBytes": "A String", # The chunk size of checksums. Must be a multiple of 256KB.
+      "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # If set, calculate the checksums based on the contents and return them to the caller.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+      "objectSizeBytes": "A String", # The total size of the server object.
+      "objectVersion": "A String", # The object version of the object the checksums are being returned for.
+    },
+    "diffDownloadResponse": { # Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
+      "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The original object location.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+    },
+    "diffUploadRequest": { # A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_REQUEST.
+      "checksumsInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+      "objectInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+      "objectVersion": "A String", # The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
+    },
+    "diffUploadResponse": { # Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_RESPONSE.
+      "objectVersion": "A String", # The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
+      "originalObject": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
+        "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+        "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+          "blobGeneration": "A String", # The blob generation id.
+          "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+          "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+          "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+          "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+        },
+        "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+        "crc32cHash": 42, # crc32.c hash for the payload.
+        "inline": "A String", # Media data, set if reference_type is INLINE
+        "length": "A String", # Size of the data, in bytes
+        "md5Hash": "A String", # MD5 hash for the payload.
+        "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+          "bucketName": "A String", # The name of the bucket to which this object belongs.
+          "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+          "objectName": "A String", # The name of the object.
+        },
+        "path": "A String", # Path to the data, set if reference_type is PATH
+        "referenceType": "A String", # Describes what the field reference contains.
+        "sha1Hash": "A String", # SHA-1 hash for the payload.
+      },
+    },
+    "diffVersionResponse": { # Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_VERSION_RESPONSE.
+      "objectSizeBytes": "A String", # The total size of the server object.
+      "objectVersion": "A String", # The version of the object stored at the server.
+    },
+    "downloadParameters": { # Parameters specific to media downloads. # Parameters for a media download.
+      "allowGzipCompression": True or False, # A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
+      "ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
+    },
+    "filename": "A String", # Original file name
+    "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
+    "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
+    "inline": "A String", # Media data, set if reference_type is INLINE
+    "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
+    "length": "A String", # Size of the data, in bytes
+    "md5Hash": "A String", # Scotty-provided MD5 hash for an upload.
+    "mediaId": "A String", # Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
+    "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+      "bucketName": "A String", # The name of the bucket to which this object belongs.
+      "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+      "objectName": "A String", # The name of the object.
+    },
+    "path": "A String", # Path to the data, set if reference_type is PATH
+    "referenceType": "A String", # Describes what the field reference contains.
+    "sha1Hash": "A String", # Scotty-provided SHA1 hash for an upload.
+    "sha256Hash": "A String", # Scotty-provided SHA256 hash for an upload.
+    "timestamp": "A String", # Time at which the media data was last updated, in milliseconds since UNIX epoch
+    "token": "A String", # A unique fingerprint/version id for the media data
+  },
+  "mediaRequestInfo": { # Extra information added to operations that support Scotty media requests. # Media upload request metadata.
+    "currentBytes": "A String", # The number of current bytes uploaded or downloaded.
+    "customData": "A String", # Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
+    "diffObjectVersion": "A String", # Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.
+    "finalStatus": 42, # The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929
+    "notificationType": "A String", # The type of notification received from Scotty.
+    "physicalHeaders": "A String", # The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.
+    "requestId": "A String", # The Scotty request ID.
+    "requestReceivedParamsServingInfo": "A String", # The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()
+    "totalBytes": "A String", # The total size of the file.
+    "totalBytesIsEstimated": True or False, # Whether the total bytes field contains an estimated data.
+  },
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the AssistantService.UploadSessionFile method.
+  "fileId": "A String", # The ID of the uploaded file.
+  "mediaResponseInfo": { # This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 } # Media upload response metadata.
+    "customData": "A String", # Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.
+    "dataStorageTransform": "A String", # Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.
+    "destinationBlobMintIndex": 42, # For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
+    "dynamicDropTarget": "A String", # Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.
+    "dynamicDropzone": "A String", # Specifies the Scotty dropzone to use for uploads.
+    "mediaForDiff": { # A reference to data stored on the filesystem, on GFS or in blobstore. # Diff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information.
+      "algorithm": "A String", # Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only possible value for this field. New values may be added at any time.
+      "bigstoreObjectRef": "A String", # Use object_id instead.
+      "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+      "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+        "blobGeneration": "A String", # The blob generation id.
+        "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+        "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+        "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+        "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+      },
+      "compositeMedia": [ # A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.
+        { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+      ],
+      "contentType": "A String", # MIME type of the data
+      "contentTypeInfo": { # Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty. # Extended content type information provided for Scotty uploads.
+        "bestGuess": "A String", # Scotty's best guess of what the content type of the file is.
+        "fromBytes": "A String", # The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
+        "fromFileName": "A String", # The content type of the file derived from the file extension of the original file name used by the client.
+        "fromHeader": "A String", # The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
+        "fromUrlPath": "A String", # The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).
+      },
+      "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+      "crc32cHash": 42, # For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.
+      "diffChecksumsResponse": { # Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
+        "checksumsLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+        "chunkSizeBytes": "A String", # The chunk size of checksums. Must be a multiple of 256KB.
+        "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # If set, calculate the checksums based on the contents and return them to the caller.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+        "objectSizeBytes": "A String", # The total size of the server object.
+        "objectVersion": "A String", # The object version of the object the checksums are being returned for.
+      },
+      "diffDownloadResponse": { # Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
+        "objectLocation": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The original object location.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+      },
+      "diffUploadRequest": { # A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_REQUEST.
+        "checksumsInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+        "objectInfo": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+        "objectVersion": "A String", # The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.
+      },
+      "diffUploadResponse": { # Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_UPLOAD_RESPONSE.
+        "objectVersion": "A String", # The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.
+        "originalObject": { # A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites. # The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
+          "blobRef": "A String", # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.
+          "blobstore2Info": { # Information to read/write to blobstore2. # Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
+            "blobGeneration": "A String", # The blob generation id.
+            "blobId": "A String", # The blob id, e.g., /blobstore/prod/playground/scotty
+            "downloadReadHandle": "A String", # Read handle passed from Bigstore -> Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.
+            "readToken": "A String", # The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
+            "uploadMetadataContainer": "A String", # Metadata passed from Blobstore -> Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.
+          },
+          "cosmoBinaryReference": "A String", # A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.
+          "crc32cHash": 42, # crc32.c hash for the payload.
+          "inline": "A String", # Media data, set if reference_type is INLINE
+          "length": "A String", # Size of the data, in bytes
+          "md5Hash": "A String", # MD5 hash for the payload.
+          "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+            "bucketName": "A String", # The name of the bucket to which this object belongs.
+            "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+            "objectName": "A String", # The name of the object.
+          },
+          "path": "A String", # Path to the data, set if reference_type is PATH
+          "referenceType": "A String", # Describes what the field reference contains.
+          "sha1Hash": "A String", # SHA-1 hash for the payload.
+        },
+      },
+      "diffVersionResponse": { # Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. # Set if reference_type is DIFF_VERSION_RESPONSE.
+        "objectSizeBytes": "A String", # The total size of the server object.
+        "objectVersion": "A String", # The version of the object stored at the server.
+      },
+      "downloadParameters": { # Parameters specific to media downloads. # Parameters for a media download.
+        "allowGzipCompression": True or False, # A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.
+        "ignoreRange": True or False, # Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
+      },
+      "filename": "A String", # Original file name
+      "hash": "A String", # Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash Hex encoded hash value of the uploaded media.
+      "hashVerified": True or False, # For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.
+      "inline": "A String", # Media data, set if reference_type is INLINE
+      "isPotentialRetry": True or False, # |is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.
+      "length": "A String", # Size of the data, in bytes
+      "md5Hash": "A String", # Scotty-provided MD5 hash for an upload.
+      "mediaId": "A String", # Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
+      "objectId": { # This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763. # Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
+        "bucketName": "A String", # The name of the bucket to which this object belongs.
+        "generation": "A String", # Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions
+        "objectName": "A String", # The name of the object.
+      },
+      "path": "A String", # Path to the data, set if reference_type is PATH
+      "referenceType": "A String", # Describes what the field reference contains.
+      "sha1Hash": "A String", # Scotty-provided SHA1 hash for an upload.
+      "sha256Hash": "A String", # Scotty-provided SHA256 hash for an upload.
+      "timestamp": "A String", # Time at which the media data was last updated, in milliseconds since UNIX epoch
+      "token": "A String", # A unique fingerprint/version id for the media data
+    },
+    "originalObjectBlobMintIndex": 42, # For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.
+    "requestClass": "A String", # Request class to use for all Blobstore operations for this request.
+    "scottyAgentUserId": "A String", # Requester ID passed along to be recorded in the Scotty logs
+    "scottyCustomerLog": "A String", # Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
+    "trafficClassField": "A String", # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.
+    "verifyHashFromHeader": True or False, # Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
+  },
+}

+

+
 
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.html b/docs/dyn/discoveryengine_v1alpha.projects.html
index 2e4f8a91e0..438d673908 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.html
@@ -120,6 +120,11 @@ 
Method Details

   An object of the form:
 
     { # Metadata and configurations for a Google Cloud project in the service.
+  "configurableBillingStatus": { # Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). # Output only. The current status of the project's configurable billing.
+    "effectiveIndexingCoreThreshold": "A String", # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
+    "effectiveSearchQpmThreshold": "A String", # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
+    "startTime": "A String", # Optional. The start time of the currently active billing subscription.
+  },
   "createTime": "A String", # Output only. The timestamp when this project is created.
   "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
     "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
@@ -127,6 +132,7 @@ 
Method Details

         "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
         "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
       },
+      "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
     },
   },
   "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
@@ -153,6 +159,11 @@ 
Method Details

     The object takes the form of:
 
 { # Metadata and configurations for a Google Cloud project in the service.
+  "configurableBillingStatus": { # Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). # Output only. The current status of the project's configurable billing.
+    "effectiveIndexingCoreThreshold": "A String", # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
+    "effectiveSearchQpmThreshold": "A String", # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
+    "startTime": "A String", # Optional. The start time of the currently active billing subscription.
+  },
   "createTime": "A String", # Output only. The timestamp when this project is created.
   "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
     "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
@@ -160,6 +171,7 @@ 
Method Details

         "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
         "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
       },
+      "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
     },
   },
   "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
@@ -185,6 +197,11 @@ 
Method Details

   An object of the form:
 
     { # Metadata and configurations for a Google Cloud project in the service.
+  "configurableBillingStatus": { # Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). # Output only. The current status of the project's configurable billing.
+    "effectiveIndexingCoreThreshold": "A String", # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
+    "effectiveSearchQpmThreshold": "A String", # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
+    "startTime": "A String", # Optional. The start time of the currently active billing subscription.
+  },
   "createTime": "A String", # Output only. The timestamp when this project is created.
   "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
     "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
@@ -192,6 +209,7 @@ 
Method Details

         "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
         "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
       },
+      "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
     },
   },
   "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
@@ -279,6 +297,11 @@ 
Method Details

   An object of the form:
 
     { # Metadata and configurations for a Google Cloud project in the service.
+  "configurableBillingStatus": { # Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month). # Output only. The current status of the project's configurable billing.
+    "effectiveIndexingCoreThreshold": "A String", # Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.
+    "effectiveSearchQpmThreshold": "A String", # Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
+    "startTime": "A String", # Optional. The start time of the currently active billing subscription.
+  },
   "createTime": "A String", # Output only. The timestamp when this project is created.
   "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
     "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
@@ -286,6 +309,7 @@ 
Method Details

         "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
         "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
       },
+      "optOutNotebookSharing": True or False, # Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
     },
   },
   "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html
new file mode 100644
index 0000000000..d67c788343
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.authorizations.html
@@ -0,0 +1,295 @@
+
+
+
+
Discovery Engine API . projects . locations . authorizations

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  create(parent, authorizationId=None, body=None, x__xgafv=None)

+
Creates an Authorization.

+

+  delete(name, x__xgafv=None)

+
Deletes an Authorization.

+

+  get(name, x__xgafv=None)

+
Gets an Authorization.

+

+  list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all Authorizations under an Engine.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Updates an Authorization

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    create(parent, authorizationId=None, body=None, x__xgafv=None)
+  
Creates an Authorization.
+
+Args:
+  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Discovery Engine Authorization resource.
+  "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
+    "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
+    "clientId": "A String", # Required. The OAuth2 client ID.
+    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
+    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
+      "A String",
+    ],
+    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
+  },
+}
+
+  authorizationId: string, Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Discovery Engine Authorization resource.
+  "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
+    "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
+    "clientId": "A String", # Required. The OAuth2 client ID.
+    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
+    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
+      "A String",
+    ],
+    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
+  },
+}

+

+
+

+    delete(name, x__xgafv=None)
+  
Deletes an Authorization.
+
+Args:
+  name: string, Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets an Authorization.
+
+Args:
+  name: string, Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Discovery Engine Authorization resource.
+  "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
+    "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
+    "clientId": "A String", # Required. The OAuth2 client ID.
+    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
+    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
+      "A String",
+    ],
+    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
+  },
+}

+

+
+

+    list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all Authorizations under an Engine.
+
+Args:
+  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
+  pageToken: string, A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the AuthorizationService.ListAuthorizations method.
+  "authorizations": [ # All the customer's Authorizations.
+    { # Discovery Engine Authorization resource.
+      "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
+        "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
+        "clientId": "A String", # Required. The OAuth2 client ID.
+        "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
+        "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
+          "A String",
+        ],
+        "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates an Authorization
+
+Args:
+  name: string, Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Discovery Engine Authorization resource.
+  "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
+    "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
+    "clientId": "A String", # Required. The OAuth2 client ID.
+    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
+    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
+      "A String",
+    ],
+    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
+  },
+}
+
+  updateMask: string, The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Discovery Engine Authorization resource.
+  "displayName": "A String", # Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "serverSideOauth2": { # OAuth2 configuration. # Server-side OAuth2 configuration.
+    "authorizationUri": "A String", # Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
+    "clientId": "A String", # Required. The OAuth2 client ID.
+    "clientSecret": "A String", # Required. The OAuth2 client secret. Encrypted at rest.
+    "scopes": [ # Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
+      "A String",
+    ],
+    "tokenUri": "A String", # Required. The HTTP endpoint that exchanges a client authorization for an access token.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
index 49879b320e..2d4d601ccc 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.completionConfig.html
@@ -124,7 +124,7 @@ 
Method Details

     "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
     "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
index aab0dbbff7..9681b4a1b2 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html
@@ -200,7 +200,7 @@ 
Method Details

   includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
   query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
   queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
-  userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  userPseudoId: string, Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -260,6 +260,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -506,6 +507,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -789,6 +791,7 @@ 
Method Details

         "state": "A String", # Output only. The states of the CmekConfig.
       },
       "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+      "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
       "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
       "createTime": "A String", # Output only. Timestamp the DataStore was created at.
       "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -979,6 +982,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -1151,6 +1155,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
index 9d8db7ad43..1571357751 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
@@ -1668,7 +1668,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
@@ -2293,7 +2293,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
index 4b6e3174d7..a12aca48ca 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
@@ -80,6 +80,9 @@ 
Instance Methods

 

   get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, x__xgafv=None)

 
Gets a WidgetConfig.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Update a WidgetConfig.

 
Method Details

 

     close()
@@ -220,9 +223,229 @@ 
Method Details

   "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
   "enableSummarization": True or False, # Turn on or off summarization for the search response.
   "enableWebApp": True or False, # Whether to enable standalone web app.
-  "experimentalFeatures": { # Allows to toggle unstable/experimental features in the widget (or web app)
-    "a_key": "A String",
+  "facetField": [ # The configuration and appearance of facets in the end user view.
+    { # Facet fields that store the mapping of fields to end user widget appearance.
+      "displayName": "A String", # Optional. The field name that end users will see.
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  ],
+  "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+    "a_key": { # Facet field that maps to a UI Component.
+      "deviceVisibility": [ # The field visibility on different types of devices.
+        "A String",
+      ],
+      "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
+  "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
+      { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
+        "destinationUri": "A String", # Optional. Destination URL of shortcut.
+        "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
+          "url": "A String", # Image URL.
+        },
+        "title": "A String", # Optional. Title of the shortcut.
+      },
+    ],
+  },
+  "industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
+  "llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
+  "minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
+  "name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "resultDisplayType": "A String", # The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
+  "uiBranding": { # Describes widget UI branding settings. # Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
+    "logo": { # Options to store an image. # Logo image.
+      "url": "A String", # Image URL.
+    },
+  },
+  "uiSettings": { # Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. # Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
+    "dataStoreUiConfigs": [ # Per data store configuration.
+      { # UI component configuration for data store.
+        "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+          { # Facet fields that store the mapping of fields to end user widget appearance.
+            "displayName": "A String", # Optional. The field name that end users will see.
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        ],
+        "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+          "a_key": { # Facet field that maps to a UI Component.
+            "deviceVisibility": [ # The field visibility on different types of devices.
+              "A String",
+            ],
+            "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        },
+        "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+        "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+      },
+    ],
+    "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+    "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
+    "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
+    "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
+    "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+    "enableSafeSearch": True or False, # Whether to enable safe search.
+    "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
+    "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
+      "a_key": "A String",
+    },
+    "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
+      "disableRelatedQuestions": True or False, # Whether generated answer contains suggested related questions.
+      "ignoreAdversarialQuery": True or False, # Optional. Specifies whether to filter out queries that are adversarial.
+      "ignoreLowRelevantContent": True or False, # Optional. Specifies whether to filter out queries that are not relevant to the content.
+      "ignoreNonAnswerSeekingQuery": True or False, # Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+      "imageSource": "A String", # Optional. Source of image returned in the answer.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
+      "modelPromptPreamble": "A String", # Text at the beginning of the prompt that instructs the model that generates the answer.
+      "modelVersion": "A String", # The model version used to generate the answer.
+      "resultCount": 42, # The number of top results to generate the answer from. Up to 10.
+    },
+    "interactionType": "A String", # Describes widget (or web app) interaction type
+    "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
+}

+
+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Update a WidgetConfig.
+
+Args:
+  name: string, Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # WidgetConfig captures configs at the Widget level.
+  "accessSettings": { # Describes widget access settings. # Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
+    "allowPublicAccess": True or False, # Whether public unauthenticated access is allowed.
+    "allowlistedDomains": [ # List of domains that are allowed to integrate the search widget.
+      "A String",
+    ],
+    "enableWebApp": True or False, # Whether web app access is enabled.
+    "languageCode": "A String", # Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
+    "workforceIdentityPoolProvider": "A String", # Optional. The workforce identity pool provider used to access the widget.
+  },
+  "allowPublicAccess": True or False, # Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
+  "allowlistedDomains": [ # Allowlisted domains that can load this widget.
+    "A String",
+  ],
+  "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget.
+    "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
+    "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context.
+    "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
+    "webGroundingType": "A String", # Optional. The type of web grounding to use.
   },
+  "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
+    { # Read-only collection component that contains data store collections fields that may be used for filtering
+      "connectorIconLink": "A String", # Output only. The icon link of the connector source.
+      "dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`.
+      "dataSourceDisplayName": "A String", # Output only. The display name of the data source.
+      "dataStoreComponents": [ # For the data store collection, list of the children data stores.
+        { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
+          "contentConfig": "A String", # Output only. The content config of the data store.
+          "dataStoreConfigType": "A String", # Output only. The type of the data store config.
+          "displayName": "A String", # The display name of the data store.
+          "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
+          "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+          "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+          "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.
+        },
+      ],
+      "displayName": "A String", # The display name of the collection.
+      "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
+      "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig.
+  "contentSearchSpec": { # A specification for configuring the behavior of content search. # The content search spec that configs the desired behavior of content search.
+    "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+      "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+      "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+    },
+    "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+      "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+      "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+      "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+      "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+      "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+    },
+    "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+    "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+      "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+      "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+      "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+    },
+    "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+      "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+      "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+      "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+      "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+      "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+        "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+      },
+      "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+        "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+      },
+      "multimodalSpec": { # Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. # Optional. Multimodal specification.
+        "imageSource": "A String", # Optional. Source of image returned in the answer.
+      },
+      "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+      "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp the WidgetConfig was created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
+    "customerType": "A String", # Customer type.
+  },
+  "dataStoreType": "A String", # Output only. The type of the parent data store.
+  "dataStoreUiConfigs": [ # Configurable UI configurations per data store.
+    { # UI component configuration for data store.
+      "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+        { # Facet fields that store the mapping of fields to end user widget appearance.
+          "displayName": "A String", # Optional. The field name that end users will see.
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      ],
+      "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+        "a_key": { # Facet field that maps to a UI Component.
+          "deviceVisibility": [ # The field visibility on different types of devices.
+            "A String",
+          ],
+          "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      },
+      "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+      "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+  "displayName": "A String", # Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+  "enableConversationalSearch": True or False, # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
+  "enablePrivateKnowledgeGraph": True or False, # Optional. Output only. Whether to enable private knowledge graph.
+  "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+  "enableResultScore": True or False, # Whether to show the result score.
+  "enableSafeSearch": True or False, # Whether to enable safe search.
+  "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget
+  "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
+  "enableSummarization": True or False, # Turn on or off summarization for the search response.
+  "enableWebApp": True or False, # Whether to enable standalone web app.
   "facetField": [ # The configuration and appearance of facets in the end user view.
     { # Facet fields that store the mapping of fields to end user widget appearance.
       "displayName": "A String", # Optional. The field name that end users will see.
@@ -238,8 +461,9 @@ 
Method Details

       "field": "A String", # Required. Registered field name. The format is `field.abc`.
     },
   },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
   "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
-    "shortcuts": [ # Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
       { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
         "destinationUri": "A String", # Optional. Destination URL of shortcut.
         "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
@@ -308,6 +532,233 @@ 
Method Details

     },
     "interactionType": "A String", # Describes widget (or web app) interaction type
     "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
+}
+
+  updateMask: string, Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # WidgetConfig captures configs at the Widget level.
+  "accessSettings": { # Describes widget access settings. # Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
+    "allowPublicAccess": True or False, # Whether public unauthenticated access is allowed.
+    "allowlistedDomains": [ # List of domains that are allowed to integrate the search widget.
+      "A String",
+    ],
+    "enableWebApp": True or False, # Whether web app access is enabled.
+    "languageCode": "A String", # Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
+    "workforceIdentityPoolProvider": "A String", # Optional. The workforce identity pool provider used to access the widget.
+  },
+  "allowPublicAccess": True or False, # Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
+  "allowlistedDomains": [ # Allowlisted domains that can load this widget.
+    "A String",
+  ],
+  "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget.
+    "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
+    "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context.
+    "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
+    "webGroundingType": "A String", # Optional. The type of web grounding to use.
+  },
+  "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
+    { # Read-only collection component that contains data store collections fields that may be used for filtering
+      "connectorIconLink": "A String", # Output only. The icon link of the connector source.
+      "dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`.
+      "dataSourceDisplayName": "A String", # Output only. The display name of the data source.
+      "dataStoreComponents": [ # For the data store collection, list of the children data stores.
+        { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
+          "contentConfig": "A String", # Output only. The content config of the data store.
+          "dataStoreConfigType": "A String", # Output only. The type of the data store config.
+          "displayName": "A String", # The display name of the data store.
+          "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
+          "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+          "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+          "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.
+        },
+      ],
+      "displayName": "A String", # The display name of the collection.
+      "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
+      "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig.
+  "contentSearchSpec": { # A specification for configuring the behavior of content search. # The content search spec that configs the desired behavior of content search.
+    "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+      "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+      "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+    },
+    "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+      "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+      "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+      "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+      "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+      "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+    },
+    "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+    "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+      "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+      "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+      "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+    },
+    "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+      "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+      "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+      "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+      "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+      "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+        "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+      },
+      "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+        "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+      },
+      "multimodalSpec": { # Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. # Optional. Multimodal specification.
+        "imageSource": "A String", # Optional. Source of image returned in the answer.
+      },
+      "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+      "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp the WidgetConfig was created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
+    "customerType": "A String", # Customer type.
+  },
+  "dataStoreType": "A String", # Output only. The type of the parent data store.
+  "dataStoreUiConfigs": [ # Configurable UI configurations per data store.
+    { # UI component configuration for data store.
+      "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+        { # Facet fields that store the mapping of fields to end user widget appearance.
+          "displayName": "A String", # Optional. The field name that end users will see.
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      ],
+      "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+        "a_key": { # Facet field that maps to a UI Component.
+          "deviceVisibility": [ # The field visibility on different types of devices.
+            "A String",
+          ],
+          "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      },
+      "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+      "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+  "displayName": "A String", # Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+  "enableConversationalSearch": True or False, # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
+  "enablePrivateKnowledgeGraph": True or False, # Optional. Output only. Whether to enable private knowledge graph.
+  "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+  "enableResultScore": True or False, # Whether to show the result score.
+  "enableSafeSearch": True or False, # Whether to enable safe search.
+  "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget
+  "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
+  "enableSummarization": True or False, # Turn on or off summarization for the search response.
+  "enableWebApp": True or False, # Whether to enable standalone web app.
+  "facetField": [ # The configuration and appearance of facets in the end user view.
+    { # Facet fields that store the mapping of fields to end user widget appearance.
+      "displayName": "A String", # Optional. The field name that end users will see.
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  ],
+  "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+    "a_key": { # Facet field that maps to a UI Component.
+      "deviceVisibility": [ # The field visibility on different types of devices.
+        "A String",
+      ],
+      "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
+  "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
+      { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
+        "destinationUri": "A String", # Optional. Destination URL of shortcut.
+        "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
+          "url": "A String", # Image URL.
+        },
+        "title": "A String", # Optional. Title of the shortcut.
+      },
+    ],
+  },
+  "industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
+  "llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
+  "minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
+  "name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "resultDisplayType": "A String", # The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
+  "uiBranding": { # Describes widget UI branding settings. # Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
+    "logo": { # Options to store an image. # Logo image.
+      "url": "A String", # Image URL.
+    },
+  },
+  "uiSettings": { # Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. # Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
+    "dataStoreUiConfigs": [ # Per data store configuration.
+      { # UI component configuration for data store.
+        "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+          { # Facet fields that store the mapping of fields to end user widget appearance.
+            "displayName": "A String", # Optional. The field name that end users will see.
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        ],
+        "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+          "a_key": { # Facet field that maps to a UI Component.
+            "deviceVisibility": [ # The field visibility on different types of devices.
+              "A String",
+            ],
+            "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        },
+        "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+        "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+      },
+    ],
+    "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+    "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
+    "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
+    "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
+    "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+    "enableSafeSearch": True or False, # Whether to enable safe search.
+    "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
+    "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
+      "a_key": "A String",
+    },
+    "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
+      "disableRelatedQuestions": True or False, # Whether generated answer contains suggested related questions.
+      "ignoreAdversarialQuery": True or False, # Optional. Specifies whether to filter out queries that are adversarial.
+      "ignoreLowRelevantContent": True or False, # Optional. Specifies whether to filter out queries that are not relevant to the content.
+      "ignoreNonAnswerSeekingQuery": True or False, # Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+      "imageSource": "A String", # Optional. Source of image returned in the answer.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
+      "modelPromptPreamble": "A String", # Text at the beginning of the prompt that instructs the model that generates the answer.
+      "modelVersion": "A String", # The model version used to generate the answer.
+      "resultCount": 42, # The number of top results to generate the answer from. Up to 10.
+    },
+    "interactionType": "A String", # Describes widget (or web app) interaction type
+    "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
   },
   "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
 }

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.files.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.files.html
new file mode 100644
index 0000000000..0dd500a1ad
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.files.html
@@ -0,0 +1,120 @@
+
+
+
+
Discovery Engine API . projects . locations . collections . engines . assistants . agents . files

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  import_(parent, body=None, x__xgafv=None)

+
Imports a file to an Agent. Currently only No-Code agents are supported.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    import_(parent, body=None, x__xgafv=None)
+  
Imports a file to an Agent. Currently only No-Code agents are supported.
+
+Args:
+  parent: string, Required. The resource name of the Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the AgentService.ImportAgentFile method.
+  "fileName": "A String", # Required. The name of the file.
+  "mimeType": "A String", # Optional. The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml. This field is required when the data source does not provide the content type.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the AgentService.ImportAgentFile method.
+  "agentFile": { # Describes a file used internally by an agent as a context on each invocation. # The imported AgentFile.
+    "fileName": "A String", # Required. The name of the file.
+    "mimeType": "A String", # Immutable. The content type of the file.
+    "name": "A String", # Identifier. The resource name of the file. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}/files/{file}`
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html
new file mode 100644
index 0000000000..b44c0414ce
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.agents.html
@@ -0,0 +1,473 @@
+
+
+
+
Discovery Engine API . projects . locations . collections . engines . assistants . agents

+
Instance Methods

+

+  files()
+

+
Returns the files Resource.

+
+

+  close()

+
Close httplib2 connections.

+

+  create(parent, body=None, x__xgafv=None)

+
Creates an Agent.

+

+  delete(name, x__xgafv=None)

+
Deletes an Agent.

+

+  get(name, x__xgafv=None)

+
Gets an Agent.

+

+  list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all Agents under an Assistant which were created by the caller.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Updates an Agent

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    create(parent, body=None, x__xgafv=None)
+  
Creates an Agent.
+
+Args:
+  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Performs a predefined, specific task.
+  "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
+    "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
+  },
+  "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
+    "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
+      "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+    },
+  },
+  "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
+    "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
+    "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this Agent was created.
+  "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
+  "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
+  "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
+    "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
+  },
+  "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
+    "content": "A String", # Base64-encoded image file contents.
+    "uri": "A String", # Image URI.
+  },
+  "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
+  "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
+  "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
+  "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
+    { # The starter prompt suggestion to show the user on the landing page of the agent.
+      "text": "A String", # Required. The text of the starter prompt.
+    },
+  ],
+  "state": "A String", # Output only. The lifecycle state of the agent.
+  "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
+  "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Performs a predefined, specific task.
+  "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
+    "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
+  },
+  "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
+    "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
+      "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+    },
+  },
+  "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
+    "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
+    "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this Agent was created.
+  "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
+  "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
+  "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
+    "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
+  },
+  "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
+    "content": "A String", # Base64-encoded image file contents.
+    "uri": "A String", # Image URI.
+  },
+  "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
+  "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
+  "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
+  "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
+    { # The starter prompt suggestion to show the user on the landing page of the agent.
+      "text": "A String", # Required. The text of the starter prompt.
+    },
+  ],
+  "state": "A String", # Output only. The lifecycle state of the agent.
+  "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
+  "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
+}

+

+
+

+    delete(name, x__xgafv=None)
+  
Deletes an Agent.
+
+Args:
+  name: string, Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets an Agent.
+
+Args:
+  name: string, Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Performs a predefined, specific task.
+  "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
+    "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
+  },
+  "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
+    "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
+      "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+    },
+  },
+  "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
+    "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
+    "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this Agent was created.
+  "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
+  "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
+  "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
+    "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
+  },
+  "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
+    "content": "A String", # Base64-encoded image file contents.
+    "uri": "A String", # Image URI.
+  },
+  "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
+  "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
+  "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
+  "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
+    { # The starter prompt suggestion to show the user on the landing page of the agent.
+      "text": "A String", # Required. The text of the starter prompt.
+    },
+  ],
+  "state": "A String", # Output only. The lifecycle state of the agent.
+  "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
+  "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
+}

+

+
+

+    list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all Agents under an Assistant which were created by the caller.
+
+Args:
+  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * "update_time desc" * "is_pinned desc,update_time desc": list agents by is_pinned first, then by update_time.
+  pageSize: integer, Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
+  pageToken: string, Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the AgentService.ListAgents method.
+  "agents": [ # The agents visible to the caller under the parent Assistant.
+    { # Performs a predefined, specific task.
+      "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
+        "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
+      },
+      "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
+        "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
+          "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+        },
+      },
+      "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
+        "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
+        "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
+          "A String",
+        ],
+      },
+      "createTime": "A String", # Output only. Timestamp when this Agent was created.
+      "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
+      "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
+      "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+      "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
+        "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
+      },
+      "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+      "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
+        "content": "A String", # Base64-encoded image file contents.
+        "uri": "A String", # Image URI.
+      },
+      "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
+      "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
+      "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
+      "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
+        { # The starter prompt suggestion to show the user on the landing page of the agent.
+          "text": "A String", # Required. The text of the starter prompt.
+        },
+      ],
+      "state": "A String", # Output only. The lifecycle state of the agent.
+      "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
+      "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates an Agent
+
+Args:
+  name: string, Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Performs a predefined, specific task.
+  "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
+    "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
+  },
+  "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
+    "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
+      "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+    },
+  },
+  "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
+    "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
+    "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this Agent was created.
+  "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
+  "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
+  "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
+    "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
+  },
+  "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
+    "content": "A String", # Base64-encoded image file contents.
+    "uri": "A String", # Image URI.
+  },
+  "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
+  "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
+  "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
+  "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
+    { # The starter prompt suggestion to show the user on the landing page of the agent.
+      "text": "A String", # Required. The text of the starter prompt.
+    },
+  ],
+  "state": "A String", # Output only. The lifecycle state of the agent.
+  "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
+  "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Performs a predefined, specific task.
+  "a2aAgentDefinition": { # Stored definition of an agent that uses A2A. # Optional. The behavior of the agent is defined as an A2A agent.
+    "jsonAgentCard": "A String", # Optional. The agent card is a JSON string.
+  },
+  "adkAgentDefinition": { # Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine). # Optional. The behavior of the agent is defined as an ADK agent.
+    "provisionedReasoningEngine": { # Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine. # Optional. The reasoning engine that the agent is connected to.
+      "reasoningEngine": "A String", # Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+    },
+  },
+  "authorizationConfig": { # Describes the authorizations required. # Optional. The authorizations that are required by the agent.
+    "agentAuthorization": "A String", # Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.
+    "toolAuthorizations": [ # Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.
+      "A String",
+    ],
+  },
+  "createTime": "A String", # Output only. Timestamp when this Agent was created.
+  "customPlaceholderText": "A String", # Optional. The custom placeholder text that appears in the text box before the user enters any text.
+  "deploymentFailureReason": "A String", # Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.
+  "description": "A String", # Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "dialogflowAgentDefinition": { # Stored definition of an agent that uses a Dialogflow agent. # Optional. The behavior of the agent is defined as a Dialogflow agent.
+    "dialogflowAgent": "A String", # Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`
+  },
+  "displayName": "A String", # Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.
+  "icon": { # Represents an image. # Optional. The icon that represents the agent on the UI.
+    "content": "A String", # Base64-encoded image file contents.
+    "uri": "A String", # Image URI.
+  },
+  "languageCode": "A String", # Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
+  "name": "A String", # Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`
+  "rejectionReason": "A String", # Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.
+  "starterPrompts": [ # Optional. The starter prompt suggestions to show the user on the landing page of the agent.
+    { # The starter prompt suggestion to show the user on the landing page of the agent.
+      "text": "A String", # Required. The text of the starter prompt.
+    },
+  ],
+  "state": "A String", # Output only. The lifecycle state of the agent.
+  "suspensionReason": "A String", # Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.
+  "updateTime": "A String", # Output only. Timestamp when this Agent was most recently updated.
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.cannedQueries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.cannedQueries.html
new file mode 100644
index 0000000000..102af6c907
--- /dev/null
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.cannedQueries.html
@@ -0,0 +1,404 @@
+
+
+
+
Discovery Engine API . projects . locations . collections . engines . assistants . cannedQueries

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  create(parent, body=None, cannedQueryId=None, x__xgafv=None)

+
Creates a CannedQuery.

+

+  delete(name, x__xgafv=None)

+
Deletes a CannedQuery.

+

+  get(name, x__xgafv=None)

+
Gets a CannedQuery.

+

+  list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all CannedQuerys under an Assistant.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Updates a CannedQuery.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    create(parent, body=None, cannedQueryId=None, x__xgafv=None)
+  
Creates a CannedQuery.
+
+Args:
+  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
+  "defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
+    "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+    "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+      { # A suggested prompt for the canned query.
+        "promptText": "A String", # Required. The text of the suggested prompt.
+      },
+    ],
+    "title": "A String", # Required. The title that is for the end user.
+  },
+  "displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "enabled": True or False, # Whether this canned query is enabled.
+  "googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
+  "localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
+    "a_key": { # The text pieces for the canned query, which can be localized.
+      "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+      "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+        { # A suggested prompt for the canned query.
+          "promptText": "A String", # Required. The text of the suggested prompt.
+        },
+      ],
+      "title": "A String", # Required. The title that is for the end user.
+    },
+  },
+  "name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
+    { # Capability of an assistant needed to use this canned query.
+      "actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
+    },
+  ],
+}
+
+  cannedQueryId: string, Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
+  "defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
+    "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+    "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+      { # A suggested prompt for the canned query.
+        "promptText": "A String", # Required. The text of the suggested prompt.
+      },
+    ],
+    "title": "A String", # Required. The title that is for the end user.
+  },
+  "displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "enabled": True or False, # Whether this canned query is enabled.
+  "googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
+  "localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
+    "a_key": { # The text pieces for the canned query, which can be localized.
+      "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+      "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+        { # A suggested prompt for the canned query.
+          "promptText": "A String", # Required. The text of the suggested prompt.
+        },
+      ],
+      "title": "A String", # Required. The title that is for the end user.
+    },
+  },
+  "name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
+    { # Capability of an assistant needed to use this canned query.
+      "actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
+    },
+  ],
+}

+

+
+

+    delete(name, x__xgafv=None)
+  
Deletes a CannedQuery.
+
+Args:
+  name: string, Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets a CannedQuery.
+
+Args:
+  name: string, Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
+  "defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
+    "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+    "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+      { # A suggested prompt for the canned query.
+        "promptText": "A String", # Required. The text of the suggested prompt.
+      },
+    ],
+    "title": "A String", # Required. The title that is for the end user.
+  },
+  "displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "enabled": True or False, # Whether this canned query is enabled.
+  "googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
+  "localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
+    "a_key": { # The text pieces for the canned query, which can be localized.
+      "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+      "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+        { # A suggested prompt for the canned query.
+          "promptText": "A String", # Required. The text of the suggested prompt.
+        },
+      ],
+      "title": "A String", # Required. The title that is for the end user.
+    },
+  },
+  "name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
+    { # Capability of an assistant needed to use this canned query.
+      "actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
+    },
+  ],
+}

+

+
+

+    list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all CannedQuerys under an Assistant.
+
+Args:
+  parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` (required)
+  filter: string, Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`
+  pageSize: integer, Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
+  pageToken: string, A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the CannedQueryService.ListCannedQueries method.
+  "cannedQueries": [ # The list of CannedQuerys matching the request.
+    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
+      "defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
+        "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+        "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+          { # A suggested prompt for the canned query.
+            "promptText": "A String", # Required. The text of the suggested prompt.
+          },
+        ],
+        "title": "A String", # Required. The title that is for the end user.
+      },
+      "displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
+      "enabled": True or False, # Whether this canned query is enabled.
+      "googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
+      "localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
+        "a_key": { # The text pieces for the canned query, which can be localized.
+          "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+          "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+            { # A suggested prompt for the canned query.
+              "promptText": "A String", # Required. The text of the suggested prompt.
+            },
+          ],
+          "title": "A String", # Required. The title that is for the end user.
+        },
+      },
+      "name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
+        { # Capability of an assistant needed to use this canned query.
+          "actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates a CannedQuery.
+
+Args:
+  name: string, Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
+  "defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
+    "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+    "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+      { # A suggested prompt for the canned query.
+        "promptText": "A String", # Required. The text of the suggested prompt.
+      },
+    ],
+    "title": "A String", # Required. The title that is for the end user.
+  },
+  "displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "enabled": True or False, # Whether this canned query is enabled.
+  "googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
+  "localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
+    "a_key": { # The text pieces for the canned query, which can be localized.
+      "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+      "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+        { # A suggested prompt for the canned query.
+          "promptText": "A String", # Required. The text of the suggested prompt.
+        },
+      ],
+      "title": "A String", # Required. The title that is for the end user.
+    },
+  },
+  "name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
+    { # Capability of an assistant needed to use this canned query.
+      "actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
+    },
+  ],
+}
+
+  updateMask: string, The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.
+  "defaultTexts": { # The text pieces for the canned query, which can be localized. # Required. The default (non-localized) values for the text attributes.
+    "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+    "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+      { # A suggested prompt for the canned query.
+        "promptText": "A String", # Required. The text of the suggested prompt.
+      },
+    ],
+    "title": "A String", # Required. The title that is for the end user.
+  },
+  "displayName": "A String", # The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.
+  "enabled": True or False, # Whether this canned query is enabled.
+  "googleDefined": True or False, # Output only. Whether this is a Google-defined, read-only canned query.
+  "localizedTexts": { # Optional. The translations of the text attributes. The keys should be BCP-47 language codes.
+    "a_key": { # The text pieces for the canned query, which can be localized.
+      "prefix": "A String", # Optional. The prefix that `suggested_prompts` should start with.
+      "suggestedPrompts": [ # Required. The prompts the canned query will offer to the user.
+        { # A suggested prompt for the canned query.
+          "promptText": "A String", # Required. The text of the suggested prompt.
+        },
+      ],
+      "title": "A String", # Required. The title that is for the end user.
+    },
+  },
+  "name": "A String", # Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "requiredCapabilities": [ # Optional. The capabilities the Assistant needs to have to use this canned query.
+    { # Capability of an assistant needed to use this canned query.
+      "actionName": "A String", # The name of the action that the Assistant needs to have set up to use this canned query.
+    },
+  ],
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
index 3fc9f32904..85cd7a2b14 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
@@ -74,6 +74,16 @@
 
 
Discovery Engine API . projects . locations . collections . engines . assistants

 
Instance Methods

+

+  agents()
+

+
Returns the agents Resource.

+
+

+  cannedQueries()
+

+
Returns the cannedQueries Resource.

+
 

   close()

 
Close httplib2 connections.

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html
index d5fba2c650..e86a046aae 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.completionConfig.html
@@ -127,7 +127,7 @@ 
Method Details

     "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
     "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
index 7e996597b8..507be78c12 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
@@ -1668,7 +1668,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
@@ -2293,7 +2293,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
index 5fc2094251..1781940017 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
@@ -80,6 +80,9 @@ 
Instance Methods

 

   get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, x__xgafv=None)

 
Gets a WidgetConfig.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Update a WidgetConfig.

 
Method Details

 

     close()
@@ -220,9 +223,229 @@ 
Method Details

   "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
   "enableSummarization": True or False, # Turn on or off summarization for the search response.
   "enableWebApp": True or False, # Whether to enable standalone web app.
-  "experimentalFeatures": { # Allows to toggle unstable/experimental features in the widget (or web app)
-    "a_key": "A String",
+  "facetField": [ # The configuration and appearance of facets in the end user view.
+    { # Facet fields that store the mapping of fields to end user widget appearance.
+      "displayName": "A String", # Optional. The field name that end users will see.
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  ],
+  "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+    "a_key": { # Facet field that maps to a UI Component.
+      "deviceVisibility": [ # The field visibility on different types of devices.
+        "A String",
+      ],
+      "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
+  "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
+      { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
+        "destinationUri": "A String", # Optional. Destination URL of shortcut.
+        "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
+          "url": "A String", # Image URL.
+        },
+        "title": "A String", # Optional. Title of the shortcut.
+      },
+    ],
+  },
+  "industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
+  "llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
+  "minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
+  "name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "resultDisplayType": "A String", # The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
+  "uiBranding": { # Describes widget UI branding settings. # Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
+    "logo": { # Options to store an image. # Logo image.
+      "url": "A String", # Image URL.
+    },
+  },
+  "uiSettings": { # Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. # Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
+    "dataStoreUiConfigs": [ # Per data store configuration.
+      { # UI component configuration for data store.
+        "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+          { # Facet fields that store the mapping of fields to end user widget appearance.
+            "displayName": "A String", # Optional. The field name that end users will see.
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        ],
+        "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+          "a_key": { # Facet field that maps to a UI Component.
+            "deviceVisibility": [ # The field visibility on different types of devices.
+              "A String",
+            ],
+            "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        },
+        "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+        "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+      },
+    ],
+    "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+    "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
+    "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
+    "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
+    "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+    "enableSafeSearch": True or False, # Whether to enable safe search.
+    "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
+    "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
+      "a_key": "A String",
+    },
+    "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
+      "disableRelatedQuestions": True or False, # Whether generated answer contains suggested related questions.
+      "ignoreAdversarialQuery": True or False, # Optional. Specifies whether to filter out queries that are adversarial.
+      "ignoreLowRelevantContent": True or False, # Optional. Specifies whether to filter out queries that are not relevant to the content.
+      "ignoreNonAnswerSeekingQuery": True or False, # Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+      "imageSource": "A String", # Optional. Source of image returned in the answer.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
+      "modelPromptPreamble": "A String", # Text at the beginning of the prompt that instructs the model that generates the answer.
+      "modelVersion": "A String", # The model version used to generate the answer.
+      "resultCount": 42, # The number of top results to generate the answer from. Up to 10.
+    },
+    "interactionType": "A String", # Describes widget (or web app) interaction type
+    "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
+}

+
+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Update a WidgetConfig.
+
+Args:
+  name: string, Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # WidgetConfig captures configs at the Widget level.
+  "accessSettings": { # Describes widget access settings. # Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
+    "allowPublicAccess": True or False, # Whether public unauthenticated access is allowed.
+    "allowlistedDomains": [ # List of domains that are allowed to integrate the search widget.
+      "A String",
+    ],
+    "enableWebApp": True or False, # Whether web app access is enabled.
+    "languageCode": "A String", # Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
+    "workforceIdentityPoolProvider": "A String", # Optional. The workforce identity pool provider used to access the widget.
+  },
+  "allowPublicAccess": True or False, # Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
+  "allowlistedDomains": [ # Allowlisted domains that can load this widget.
+    "A String",
+  ],
+  "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget.
+    "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
+    "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context.
+    "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
+    "webGroundingType": "A String", # Optional. The type of web grounding to use.
   },
+  "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
+    { # Read-only collection component that contains data store collections fields that may be used for filtering
+      "connectorIconLink": "A String", # Output only. The icon link of the connector source.
+      "dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`.
+      "dataSourceDisplayName": "A String", # Output only. The display name of the data source.
+      "dataStoreComponents": [ # For the data store collection, list of the children data stores.
+        { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
+          "contentConfig": "A String", # Output only. The content config of the data store.
+          "dataStoreConfigType": "A String", # Output only. The type of the data store config.
+          "displayName": "A String", # The display name of the data store.
+          "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
+          "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+          "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+          "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.
+        },
+      ],
+      "displayName": "A String", # The display name of the collection.
+      "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
+      "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig.
+  "contentSearchSpec": { # A specification for configuring the behavior of content search. # The content search spec that configs the desired behavior of content search.
+    "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+      "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+      "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+    },
+    "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+      "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+      "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+      "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+      "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+      "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+    },
+    "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+    "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+      "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+      "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+      "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+    },
+    "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+      "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+      "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+      "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+      "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+      "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+        "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+      },
+      "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+        "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+      },
+      "multimodalSpec": { # Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. # Optional. Multimodal specification.
+        "imageSource": "A String", # Optional. Source of image returned in the answer.
+      },
+      "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+      "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp the WidgetConfig was created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
+    "customerType": "A String", # Customer type.
+  },
+  "dataStoreType": "A String", # Output only. The type of the parent data store.
+  "dataStoreUiConfigs": [ # Configurable UI configurations per data store.
+    { # UI component configuration for data store.
+      "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+        { # Facet fields that store the mapping of fields to end user widget appearance.
+          "displayName": "A String", # Optional. The field name that end users will see.
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      ],
+      "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+        "a_key": { # Facet field that maps to a UI Component.
+          "deviceVisibility": [ # The field visibility on different types of devices.
+            "A String",
+          ],
+          "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      },
+      "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+      "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+  "displayName": "A String", # Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+  "enableConversationalSearch": True or False, # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
+  "enablePrivateKnowledgeGraph": True or False, # Optional. Output only. Whether to enable private knowledge graph.
+  "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+  "enableResultScore": True or False, # Whether to show the result score.
+  "enableSafeSearch": True or False, # Whether to enable safe search.
+  "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget
+  "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
+  "enableSummarization": True or False, # Turn on or off summarization for the search response.
+  "enableWebApp": True or False, # Whether to enable standalone web app.
   "facetField": [ # The configuration and appearance of facets in the end user view.
     { # Facet fields that store the mapping of fields to end user widget appearance.
       "displayName": "A String", # Optional. The field name that end users will see.
@@ -238,8 +461,9 @@ 
Method Details

       "field": "A String", # Required. Registered field name. The format is `field.abc`.
     },
   },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
   "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
-    "shortcuts": [ # Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
       { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
         "destinationUri": "A String", # Optional. Destination URL of shortcut.
         "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
@@ -308,6 +532,233 @@ 
Method Details

     },
     "interactionType": "A String", # Describes widget (or web app) interaction type
     "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
+}
+
+  updateMask: string, Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # WidgetConfig captures configs at the Widget level.
+  "accessSettings": { # Describes widget access settings. # Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
+    "allowPublicAccess": True or False, # Whether public unauthenticated access is allowed.
+    "allowlistedDomains": [ # List of domains that are allowed to integrate the search widget.
+      "A String",
+    ],
+    "enableWebApp": True or False, # Whether web app access is enabled.
+    "languageCode": "A String", # Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
+    "workforceIdentityPoolProvider": "A String", # Optional. The workforce identity pool provider used to access the widget.
+  },
+  "allowPublicAccess": True or False, # Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
+  "allowlistedDomains": [ # Allowlisted domains that can load this widget.
+    "A String",
+  ],
+  "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget.
+    "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
+    "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context.
+    "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
+    "webGroundingType": "A String", # Optional. The type of web grounding to use.
+  },
+  "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
+    { # Read-only collection component that contains data store collections fields that may be used for filtering
+      "connectorIconLink": "A String", # Output only. The icon link of the connector source.
+      "dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`.
+      "dataSourceDisplayName": "A String", # Output only. The display name of the data source.
+      "dataStoreComponents": [ # For the data store collection, list of the children data stores.
+        { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
+          "contentConfig": "A String", # Output only. The content config of the data store.
+          "dataStoreConfigType": "A String", # Output only. The type of the data store config.
+          "displayName": "A String", # The display name of the data store.
+          "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
+          "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+          "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+          "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.
+        },
+      ],
+      "displayName": "A String", # The display name of the collection.
+      "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
+      "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig.
+  "contentSearchSpec": { # A specification for configuring the behavior of content search. # The content search spec that configs the desired behavior of content search.
+    "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+      "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+      "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+    },
+    "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+      "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+      "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+      "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+      "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+      "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+    },
+    "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+    "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+      "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+      "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+      "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+    },
+    "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+      "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+      "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+      "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+      "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+      "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+        "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+      },
+      "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+        "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+      },
+      "multimodalSpec": { # Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. # Optional. Multimodal specification.
+        "imageSource": "A String", # Optional. Source of image returned in the answer.
+      },
+      "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+      "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp the WidgetConfig was created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
+    "customerType": "A String", # Customer type.
+  },
+  "dataStoreType": "A String", # Output only. The type of the parent data store.
+  "dataStoreUiConfigs": [ # Configurable UI configurations per data store.
+    { # UI component configuration for data store.
+      "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+        { # Facet fields that store the mapping of fields to end user widget appearance.
+          "displayName": "A String", # Optional. The field name that end users will see.
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      ],
+      "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+        "a_key": { # Facet field that maps to a UI Component.
+          "deviceVisibility": [ # The field visibility on different types of devices.
+            "A String",
+          ],
+          "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      },
+      "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+      "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+  "displayName": "A String", # Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+  "enableConversationalSearch": True or False, # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
+  "enablePrivateKnowledgeGraph": True or False, # Optional. Output only. Whether to enable private knowledge graph.
+  "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+  "enableResultScore": True or False, # Whether to show the result score.
+  "enableSafeSearch": True or False, # Whether to enable safe search.
+  "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget
+  "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
+  "enableSummarization": True or False, # Turn on or off summarization for the search response.
+  "enableWebApp": True or False, # Whether to enable standalone web app.
+  "facetField": [ # The configuration and appearance of facets in the end user view.
+    { # Facet fields that store the mapping of fields to end user widget appearance.
+      "displayName": "A String", # Optional. The field name that end users will see.
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  ],
+  "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+    "a_key": { # Facet field that maps to a UI Component.
+      "deviceVisibility": [ # The field visibility on different types of devices.
+        "A String",
+      ],
+      "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
+  "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
+      { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
+        "destinationUri": "A String", # Optional. Destination URL of shortcut.
+        "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
+          "url": "A String", # Image URL.
+        },
+        "title": "A String", # Optional. Title of the shortcut.
+      },
+    ],
+  },
+  "industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
+  "llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
+  "minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
+  "name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "resultDisplayType": "A String", # The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
+  "uiBranding": { # Describes widget UI branding settings. # Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
+    "logo": { # Options to store an image. # Logo image.
+      "url": "A String", # Image URL.
+    },
+  },
+  "uiSettings": { # Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. # Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
+    "dataStoreUiConfigs": [ # Per data store configuration.
+      { # UI component configuration for data store.
+        "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+          { # Facet fields that store the mapping of fields to end user widget appearance.
+            "displayName": "A String", # Optional. The field name that end users will see.
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        ],
+        "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+          "a_key": { # Facet field that maps to a UI Component.
+            "deviceVisibility": [ # The field visibility on different types of devices.
+              "A String",
+            ],
+            "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        },
+        "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+        "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+      },
+    ],
+    "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+    "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
+    "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
+    "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
+    "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+    "enableSafeSearch": True or False, # Whether to enable safe search.
+    "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
+    "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
+      "a_key": "A String",
+    },
+    "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
+      "disableRelatedQuestions": True or False, # Whether generated answer contains suggested related questions.
+      "ignoreAdversarialQuery": True or False, # Optional. Specifies whether to filter out queries that are adversarial.
+      "ignoreLowRelevantContent": True or False, # Optional. Specifies whether to filter out queries that are not relevant to the content.
+      "ignoreNonAnswerSeekingQuery": True or False, # Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+      "imageSource": "A String", # Optional. Source of image returned in the answer.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
+      "modelPromptPreamble": "A String", # Text at the beginning of the prompt that instructs the model that generates the answer.
+      "modelVersion": "A String", # The model version used to generate the answer.
+      "resultCount": 42, # The number of top results to generate the answer from. Up to 10.
+    },
+    "interactionType": "A String", # Describes widget (or web app) interaction type
+    "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
   },
   "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
 }

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html
index 3021121139..4b4781203a 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.completionConfig.html
@@ -124,7 +124,7 @@ 
Method Details

     "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
     "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
index ece123a8cb..3f74f4b305 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html
@@ -192,7 +192,7 @@ 
Method Details

   includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
   query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
   queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
-  userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  userPseudoId: string, Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -252,6 +252,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -498,6 +499,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -781,6 +783,7 @@ 
Method Details

         "state": "A String", # Output only. The states of the CmekConfig.
       },
       "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+      "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
       "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
       "createTime": "A String", # Output only. Timestamp the DataStore was created at.
       "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -971,6 +974,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
@@ -1143,6 +1147,7 @@ 
Method Details

     "state": "A String", # Output only. The states of the CmekConfig.
   },
   "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See
+  "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated.
   "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
   "createTime": "A String", # Output only. Timestamp the DataStore was created at.
   "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
index 76f84fc02c..5eacacf8c3 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
@@ -1668,7 +1668,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
@@ -2293,7 +2293,7 @@ 
Method Details

   "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
     "a_key": "A String",
   },
-  "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html
index e539f634e0..24e8c52b6e 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html
@@ -80,6 +80,9 @@ 
Instance Methods

 

   get(name, acceptCache=None, getWidgetConfigRequestOption_turnOffCollectionComponents=None, x__xgafv=None)

 
Gets a WidgetConfig.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Update a WidgetConfig.

 
Method Details

 

     close()
@@ -220,9 +223,229 @@ 
Method Details

   "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
   "enableSummarization": True or False, # Turn on or off summarization for the search response.
   "enableWebApp": True or False, # Whether to enable standalone web app.
-  "experimentalFeatures": { # Allows to toggle unstable/experimental features in the widget (or web app)
-    "a_key": "A String",
+  "facetField": [ # The configuration and appearance of facets in the end user view.
+    { # Facet fields that store the mapping of fields to end user widget appearance.
+      "displayName": "A String", # Optional. The field name that end users will see.
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  ],
+  "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+    "a_key": { # Facet field that maps to a UI Component.
+      "deviceVisibility": [ # The field visibility on different types of devices.
+        "A String",
+      ],
+      "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
+  "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
+      { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
+        "destinationUri": "A String", # Optional. Destination URL of shortcut.
+        "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
+          "url": "A String", # Image URL.
+        },
+        "title": "A String", # Optional. Title of the shortcut.
+      },
+    ],
+  },
+  "industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
+  "llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
+  "minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
+  "name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "resultDisplayType": "A String", # The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
+  "uiBranding": { # Describes widget UI branding settings. # Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
+    "logo": { # Options to store an image. # Logo image.
+      "url": "A String", # Image URL.
+    },
+  },
+  "uiSettings": { # Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. # Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
+    "dataStoreUiConfigs": [ # Per data store configuration.
+      { # UI component configuration for data store.
+        "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+          { # Facet fields that store the mapping of fields to end user widget appearance.
+            "displayName": "A String", # Optional. The field name that end users will see.
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        ],
+        "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+          "a_key": { # Facet field that maps to a UI Component.
+            "deviceVisibility": [ # The field visibility on different types of devices.
+              "A String",
+            ],
+            "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        },
+        "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+        "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+      },
+    ],
+    "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+    "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
+    "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
+    "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
+    "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+    "enableSafeSearch": True or False, # Whether to enable safe search.
+    "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
+    "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
+      "a_key": "A String",
+    },
+    "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
+      "disableRelatedQuestions": True or False, # Whether generated answer contains suggested related questions.
+      "ignoreAdversarialQuery": True or False, # Optional. Specifies whether to filter out queries that are adversarial.
+      "ignoreLowRelevantContent": True or False, # Optional. Specifies whether to filter out queries that are not relevant to the content.
+      "ignoreNonAnswerSeekingQuery": True or False, # Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+      "imageSource": "A String", # Optional. Source of image returned in the answer.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
+      "modelPromptPreamble": "A String", # Text at the beginning of the prompt that instructs the model that generates the answer.
+      "modelVersion": "A String", # The model version used to generate the answer.
+      "resultCount": 42, # The number of top results to generate the answer from. Up to 10.
+    },
+    "interactionType": "A String", # Describes widget (or web app) interaction type
+    "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
+}
+ + +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Update a WidgetConfig.
+
+Args:
+  name: string, Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # WidgetConfig captures configs at the Widget level.
+  "accessSettings": { # Describes widget access settings. # Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
+    "allowPublicAccess": True or False, # Whether public unauthenticated access is allowed.
+    "allowlistedDomains": [ # List of domains that are allowed to integrate the search widget.
+      "A String",
+    ],
+    "enableWebApp": True or False, # Whether web app access is enabled.
+    "languageCode": "A String", # Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
+    "workforceIdentityPoolProvider": "A String", # Optional. The workforce identity pool provider used to access the widget.
+  },
+  "allowPublicAccess": True or False, # Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
+  "allowlistedDomains": [ # Allowlisted domains that can load this widget.
+    "A String",
+  ],
+  "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget.
+    "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
+    "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context.
+    "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
+    "webGroundingType": "A String", # Optional. The type of web grounding to use.
   },
+  "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
+    { # Read-only collection component that contains data store collections fields that may be used for filtering
+      "connectorIconLink": "A String", # Output only. The icon link of the connector source.
+      "dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`.
+      "dataSourceDisplayName": "A String", # Output only. The display name of the data source.
+      "dataStoreComponents": [ # For the data store collection, list of the children data stores.
+        { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
+          "contentConfig": "A String", # Output only. The content config of the data store.
+          "dataStoreConfigType": "A String", # Output only. The type of the data store config.
+          "displayName": "A String", # The display name of the data store.
+          "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
+          "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+          "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+          "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.
+        },
+      ],
+      "displayName": "A String", # The display name of the collection.
+      "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
+      "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig.
+  "contentSearchSpec": { # A specification for configuring the behavior of content search. # The content search spec that configs the desired behavior of content search.
+    "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+      "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+      "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+    },
+    "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+      "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+      "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+      "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+      "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+      "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+    },
+    "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+    "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+      "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+      "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+      "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+    },
+    "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+      "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+      "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+      "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+      "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+      "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+        "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+      },
+      "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+        "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+      },
+      "multimodalSpec": { # Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. # Optional. Multimodal specification.
+        "imageSource": "A String", # Optional. Source of image returned in the answer.
+      },
+      "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+      "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp the WidgetConfig was created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
+    "customerType": "A String", # Customer type.
+  },
+  "dataStoreType": "A String", # Output only. The type of the parent data store.
+  "dataStoreUiConfigs": [ # Configurable UI configurations per data store.
+    { # UI component configuration for data store.
+      "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+        { # Facet fields that store the mapping of fields to end user widget appearance.
+          "displayName": "A String", # Optional. The field name that end users will see.
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      ],
+      "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+        "a_key": { # Facet field that maps to a UI Component.
+          "deviceVisibility": [ # The field visibility on different types of devices.
+            "A String",
+          ],
+          "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      },
+      "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+      "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+  "displayName": "A String", # Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+  "enableConversationalSearch": True or False, # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
+  "enablePrivateKnowledgeGraph": True or False, # Optional. Output only. Whether to enable private knowledge graph.
+  "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+  "enableResultScore": True or False, # Whether to show the result score.
+  "enableSafeSearch": True or False, # Whether to enable safe search.
+  "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget
+  "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
+  "enableSummarization": True or False, # Turn on or off summarization for the search response.
+  "enableWebApp": True or False, # Whether to enable standalone web app.
   "facetField": [ # The configuration and appearance of facets in the end user view.
     { # Facet fields that store the mapping of fields to end user widget appearance.
       "displayName": "A String", # Optional. The field name that end users will see.
@@ -238,8 +461,9 @@ 
Method Details

       "field": "A String", # Required. Registered field name. The format is `field.abc`.
     },
   },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
   "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
-    "shortcuts": [ # Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
       { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
         "destinationUri": "A String", # Optional. Destination URL of shortcut.
         "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
@@ -308,6 +532,233 @@ 
Method Details

     },
     "interactionType": "A String", # Describes widget (or web app) interaction type
     "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
+  },
+  "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
+}
+
+  updateMask: string, Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # WidgetConfig captures configs at the Widget level.
+  "accessSettings": { # Describes widget access settings. # Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties.
+    "allowPublicAccess": True or False, # Whether public unauthenticated access is allowed.
+    "allowlistedDomains": [ # List of domains that are allowed to integrate the search widget.
+      "A String",
+    ],
+    "enableWebApp": True or False, # Whether web app access is enabled.
+    "languageCode": "A String", # Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US".
+    "workforceIdentityPoolProvider": "A String", # Optional. The workforce identity pool provider used to access the widget.
+  },
+  "allowPublicAccess": True or False, # Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server.
+  "allowlistedDomains": [ # Allowlisted domains that can load this widget.
+    "A String",
+  ],
+  "assistantSettings": { # Describes the assistant settings of the widget. # Optional. Output only. Describes the assistant settings of the widget.
+    "defaultWebGroundingToggleOff": True or False, # Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
+    "disableLocationContext": True or False, # Optional. Output only. Whether to disable user location context.
+    "googleSearchGroundingEnabled": True or False, # Whether or not the Google search grounding toggle is shown. Deprecated. Use web_grounding_type instead.
+    "webGroundingType": "A String", # Optional. The type of web grounding to use.
+  },
+  "collectionComponents": [ # Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources.
+    { # Read-only collection component that contains data store collections fields that may be used for filtering
+      "connectorIconLink": "A String", # Output only. The icon link of the connector source.
+      "dataSource": "A String", # The name of the data source, retrieved from `Collection.data_connector.data_source`.
+      "dataSourceDisplayName": "A String", # Output only. The display name of the data source.
+      "dataStoreComponents": [ # For the data store collection, list of the children data stores.
+        { # Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.
+          "contentConfig": "A String", # Output only. The content config of the data store.
+          "dataStoreConfigType": "A String", # Output only. The type of the data store config.
+          "displayName": "A String", # The display name of the data store.
+          "entityName": "A String", # The name of the entity, retrieved from `Collection.data_connector.entities.entityName`.
+          "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+          "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+          "workspaceType": "A String", # Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`.
+        },
+      ],
+      "displayName": "A String", # The display name of the collection.
+      "id": "A String", # Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID.
+      "name": "A String", # The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "configId": "A String", # Output only. Unique obfuscated identifier of a WidgetConfig.
+  "contentSearchSpec": { # A specification for configuring the behavior of content search. # The content search spec that configs the desired behavior of content search.
+    "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+      "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+      "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+    },
+    "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+      "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+      "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+      "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+      "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+      "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+    },
+    "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+    "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+      "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+      "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+      "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+    },
+    "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+      "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+      "ignoreJailBreakingQuery": True or False, # Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.
+      "ignoreLowRelevantContent": True or False, # Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.
+      "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+      "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+        "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+      },
+      "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+        "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+      },
+      "multimodalSpec": { # Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision. # Optional. Multimodal specification.
+        "imageSource": "A String", # Optional. Source of image returned in the answer.
+      },
+      "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+      "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+    },
+  },
+  "createTime": "A String", # Output only. Timestamp the WidgetConfig was created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding.
+    "customerType": "A String", # Customer type.
+  },
+  "dataStoreType": "A String", # Output only. The type of the parent data store.
+  "dataStoreUiConfigs": [ # Configurable UI configurations per data store.
+    { # UI component configuration for data store.
+      "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+        { # Facet fields that store the mapping of fields to end user widget appearance.
+          "displayName": "A String", # Optional. The field name that end users will see.
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      ],
+      "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+        "a_key": { # Facet field that maps to a UI Component.
+          "deviceVisibility": [ # The field visibility on different types of devices.
+            "A String",
+          ],
+          "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+          "field": "A String", # Required. Registered field name. The format is `field.abc`.
+        },
+      },
+      "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+      "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+    },
+  ],
+  "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+  "displayName": "A String", # Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+  "enableConversationalSearch": True or False, # Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
+  "enablePrivateKnowledgeGraph": True or False, # Optional. Output only. Whether to enable private knowledge graph.
+  "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+  "enableResultScore": True or False, # Whether to show the result score.
+  "enableSafeSearch": True or False, # Whether to enable safe search.
+  "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget
+  "enableSnippetResultSummary": True or False, # Turn on or off summary for each snippets result.
+  "enableSummarization": True or False, # Turn on or off summarization for the search response.
+  "enableWebApp": True or False, # Whether to enable standalone web app.
+  "facetField": [ # The configuration and appearance of facets in the end user view.
+    { # Facet fields that store the mapping of fields to end user widget appearance.
+      "displayName": "A String", # Optional. The field name that end users will see.
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  ],
+  "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+    "a_key": { # Facet field that maps to a UI Component.
+      "deviceVisibility": [ # The field visibility on different types of devices.
+        "A String",
+      ],
+      "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+      "field": "A String", # Required. Registered field name. The format is `field.abc`.
+    },
+  },
+  "geminiBundle": True or False, # Output only. Whether the subscription is gemini bundle or not.
+  "homepageSetting": { # Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts. # Optional. Describes the homepage settings of the widget.
+    "shortcuts": [ # Optional. The shortcuts to display on the homepage.
+      { # Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.
+        "destinationUri": "A String", # Optional. Destination URL of shortcut.
+        "icon": { # Options to store an image. # Optional. Icon URL of shortcut.
+          "url": "A String", # Image URL.
+        },
+        "title": "A String", # Optional. Title of the shortcut.
+      },
+    ],
+  },
+  "industryVertical": "A String", # Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
+  "llmEnabled": True or False, # Output only. Whether LLM is enabled in the corresponding data store.
+  "minimumDataTermAccepted": True or False, # Output only. Whether the customer accepted data use terms.
+  "name": "A String", # Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "resultDisplayType": "A String", # The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
+  "solutionType": "A String", # Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.
+  "uiBranding": { # Describes widget UI branding settings. # Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors.
+    "logo": { # Options to store an image. # Logo image.
+      "url": "A String", # Image URL.
+    },
+  },
+  "uiSettings": { # Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page. # Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties.
+    "dataStoreUiConfigs": [ # Per data store configuration.
+      { # UI component configuration for data store.
+        "facetField": [ # Facet fields that store the mapping of fields to end user widget appearance.
+          { # Facet fields that store the mapping of fields to end user widget appearance.
+            "displayName": "A String", # Optional. The field name that end users will see.
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        ],
+        "fieldsUiComponentsMap": { # The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.
+          "a_key": { # Facet field that maps to a UI Component.
+            "deviceVisibility": [ # The field visibility on different types of devices.
+              "A String",
+            ],
+            "displayTemplate": "A String", # The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}".
+            "field": "A String", # Required. Registered field name. The format is `field.abc`.
+          },
+        },
+        "id": "A String", # Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID.
+        "name": "A String", # The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
+      },
+    ],
+    "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
+    "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
+    "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
+    "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
+    "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
+    "enableSafeSearch": True or False, # Whether to enable safe search.
+    "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
+    "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
+      "a_key": "A String",
+    },
+    "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
+      "disableRelatedQuestions": True or False, # Whether generated answer contains suggested related questions.
+      "ignoreAdversarialQuery": True or False, # Optional. Specifies whether to filter out queries that are adversarial.
+      "ignoreLowRelevantContent": True or False, # Optional. Specifies whether to filter out queries that are not relevant to the content.
+      "ignoreNonAnswerSeekingQuery": True or False, # Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
+      "imageSource": "A String", # Optional. Source of image returned in the answer.
+      "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+      "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.
+      "modelPromptPreamble": "A String", # Text at the beginning of the prompt that instructs the model that generates the answer.
+      "modelVersion": "A String", # The model version used to generate the answer.
+      "resultCount": 42, # The number of top results to generate the answer from. Up to 10.
+    },
+    "interactionType": "A String", # Describes widget (or web app) interaction type
+    "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.
+    "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests.
+      "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+      "kpiPersonalizationAddOnDisabled": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+      "semanticAddOnDisabled": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+    },
   },
   "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated.
 }
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 43fca6973b..466d927d54 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -340,7 +340,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, }, "name": "A String", # Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -647,7 +647,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, }, "name": "A String", # Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -930,7 +930,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, }, "name": "A String", # Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index b8b4e09277..05bdbaa69b 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -74,6 +74,11 @@

Discovery Engine API . projects . locations

Instance Methods

+

+ authorizations() +

+

Returns the authorizations Resource.

+

cmekConfigs()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html index c2d9083795..c24ca4a458 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.html @@ -90,6 +90,18 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, userStoreId=None, x__xgafv=None)

+

Creates a new User Store.

+

+ delete(name, x__xgafv=None)

+

Deletes the User Store.

+

+ get(name, x__xgafv=None)

+

Gets the User Store.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the User Store.

Method Details

batchUpdateUserLicenses(parent, body=None, x__xgafv=None) @@ -152,4 +164,132 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, userStoreId=None, x__xgafv=None) + 
Creates a new User Store.
+
+Args:
+  parent: string, Required. The parent collection resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  userStoreId: string, Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes the User Store.
+
+Args:
+  name: string, Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets the User Store.
+
+Args:
+  name: string, Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates the User Store.
+
+Args:
+  name: string, Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html index 13836a73e0..adc6227c4d 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.completionConfig.html @@ -124,7 +124,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html index bc7fcdb490..9169670b42 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.html @@ -189,7 +189,7 @@

Method Details

includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. - userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + userPseudoId: string, Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -249,6 +249,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -469,6 +470,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -645,6 +647,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -809,6 +812,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -955,6 +959,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html index c3292d0227..1ced3258b1 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -1628,7 +1628,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } x__xgafv: string, V1 error format. @@ -2249,7 +2249,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html index 087760e569..08e048a1a0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.completionConfig.html @@ -127,7 +127,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html index 9cbe47797b..cb5add29f9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -1628,7 +1628,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } x__xgafv: string, V1 error format. @@ -2249,7 +2249,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html index f2cac290b0..86b7b5da6f 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.completionConfig.html @@ -124,7 +124,7 @@

Method Details

"userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html index bc3018281d..fb3f565eb4 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.html @@ -181,7 +181,7 @@

Method Details

includeTailSuggestions: boolean, Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. query: string, Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. queryModel: string, Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. - userPseudoId: string, A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + userPseudoId: string, Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -241,6 +241,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -461,6 +462,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -637,6 +639,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -801,6 +804,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. @@ -947,6 +951,7 @@

Method Details

"state": "A String", # Output only. The states of the CmekConfig. }, "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See + "configurableBillingApproachUpdateTime": "A String", # Output only. The timestamp when configurable_billing_approach was last updated. "contentConfig": "A String", # Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. "createTime": "A String", # Output only. Timestamp the DataStore was created at. "defaultSchemaId": "A String", # Output only. The id of the default Schema associated to this data store. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index 844c59de60..40afcd755e 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -1628,7 +1628,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } x__xgafv: string, V1 error format. @@ -2249,7 +2249,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index cd4733c7d1..eabf2f1de7 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -336,7 +336,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, }, "name": "A String", # Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -639,7 +639,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, }, "name": "A String", # Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. @@ -918,7 +918,7 @@

Method Details

"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. "a_key": "A String", }, - "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + "userPseudoId": "A String", # Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. }, }, "name": "A String", # Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.html b/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.html index 96a5b0b64e..03454fe02b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.userStores.html @@ -85,6 +85,18 @@

Instance Methods

close()

Close httplib2 connections.

+

+ create(parent, body=None, userStoreId=None, x__xgafv=None)

+

Creates a new User Store.

+

+ delete(name, x__xgafv=None)

+

Deletes the User Store.

+

+ get(name, x__xgafv=None)

+

Gets the User Store.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates the User Store.

Method Details

batchUpdateUserLicenses(parent, body=None, x__xgafv=None) @@ -147,4 +159,132 @@

Method Details

Close httplib2 connections.
+
+ create(parent, body=None, userStoreId=None, x__xgafv=None) + 
Creates a new User Store.
+
+Args:
+  parent: string, Required. The parent collection resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  userStoreId: string, Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes the User Store.
+
+Args:
+  name: string, Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets the User Store.
+
+Args:
+  name: string, Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates the User Store.
+
+Args:
+  name: string, Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Optional. The list of fields to update.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Configures metadata that is used for End User entities.
+  "defaultLicenseConfig": "A String", # Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.
+  "displayName": "A String", # The display name of the User Store.
+  "enableExpiredLicenseAutoUpdate": True or False, # Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.
+  "enableLicenseAutoRegister": True or False, # Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.
+  "name": "A String", # Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 444d559190..54b679570b 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -730,7 +730,7 @@ "type": "string" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -2281,6 +2281,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"get": { +"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", +"flatPath": "v1/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}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ServingConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all ServingConfigs linked to this dataStore.", +"flatPath": "v1/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. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/servingConfigs", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "patch": { "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -4238,6 +4301,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"get": { +"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", +"flatPath": "v1/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}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ServingConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all ServingConfigs linked to this dataStore.", +"flatPath": "v1/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. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/servingConfigs", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "patch": { "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}", @@ -4717,7 +4843,7 @@ "type": "string" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -6130,6 +6256,69 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, +"get": { +"description": "Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.", +"flatPath": "v1/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}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ServingConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all ServingConfigs linked to this dataStore.", +"flatPath": "v1/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. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/servingConfigs", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, "patch": { "description": "Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}", @@ -7795,6 +7984,127 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] +}, +"create": { +"description": "Creates a new User Store.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userStores.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"userStoreId": { +"description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/userStores", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1UserStore" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1UserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"delete": { +"description": "Deletes the User Store.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.userStores.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets the User Store.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userStores.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1UserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"patch": { +"description": "Updates the User Store.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.userStores.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1UserStore" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1UserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] } }, "resources": { @@ -7957,7 +8267,7 @@ } } }, -"revision": "20251017", +"revision": "20251030", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -8912,7 +9222,7 @@ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", "type": "string" } }, @@ -13154,6 +13464,12 @@ ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -15251,6 +15567,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ListServingConfigsResponse": { +"description": "Response for ListServingConfigs method.", +"id": "GoogleCloudDiscoveryengineV1ListServingConfigsResponse", +"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": "GoogleCloudDiscoveryengineV1ServingConfig" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1ListSessionsResponse": { "description": "Response for ListSessions method.", "id": "GoogleCloudDiscoveryengineV1ListSessionsResponse", @@ -15405,6 +15739,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -15437,6 +15776,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", @@ -15455,6 +15816,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -16331,7 +16696,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -18358,6 +18723,33 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1UserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1UserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -20994,6 +21386,12 @@ false ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -21187,6 +21585,23 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { +"description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", @@ -21334,6 +21749,23 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { +"description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", +"properties": { +"failureCount": { +"description": "The number of end users under the user store that failed to be deleted.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "The number of end users under the user store that were successfully deleted.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", @@ -22932,6 +23364,11 @@ false "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -22964,6 +23401,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", @@ -22982,6 +23441,10 @@ false "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -23807,7 +24270,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -25701,6 +26164,12 @@ false ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -27164,6 +27633,11 @@ false "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -27196,6 +27670,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", @@ -27214,6 +27710,10 @@ false "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -27713,7 +28213,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -28753,6 +29253,33 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1betaUserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 1059b71aa8..a3456fdb7c 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -141,6 +141,135 @@ }, "protocol": "rest", "resources": { +"billingAccounts": { +"resources": { +"billingAccountLicenseConfigs": { +"methods": { +"distributeLicenseConfig": { +"description": "Distributes a LicenseConfig from billing account level to project level.", +"flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig", +"httpMethod": "POST", +"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig", +"parameterOrder": [ +"billingAccountLicenseConfig" +], +"parameters": { +"billingAccountLicenseConfig": { +"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", +"location": "path", +"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+billingAccountLicenseConfig}:distributeLicenseConfig", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets a BillingAccountLicenseConfig.", +"flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}", +"httpMethod": "GET", +"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", +"location": "path", +"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all BillingAccountLicenseConfigs for a given billing account.", +"flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs", +"httpMethod": "GET", +"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Not supported.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Not supported.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: `billingAccounts/{billing_account}`.", +"location": "path", +"pattern": "^billingAccounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/billingAccountLicenseConfigs", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"retractLicenseConfig": { +"description": "This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.", +"flatPath": "v1alpha/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig", +"httpMethod": "POST", +"id": "discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig", +"parameterOrder": [ +"billingAccountLicenseConfig" +], +"parameters": { +"billingAccountLicenseConfig": { +"description": "Required. Full resource name of BillingAccountLicenseConfig. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config_id}`.", +"location": "path", +"pattern": "^billingAccounts/[^/]+/billingAccountLicenseConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+billingAccountLicenseConfig}:retractLicenseConfig", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +} +} +} +} +}, "media": { "methods": { "download": { @@ -181,6 +310,48 @@ ], "supportsMediaDownload": true, "useMediaDownloadService": true +}, +"upload": { +"description": "Uploads a file for the assistant to use as a source of information within the session.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:uploadFile", +"httpMethod": "POST", +"id": "discoveryengine.media.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v1alpha/{+name}:uploadFile" +} +} +}, +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:uploadFile", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +], +"supportsMediaUpload": true } } }, @@ -696,6 +867,168 @@ } }, "resources": { +"authorizations": { +"methods": { +"create": { +"description": "Creates an Authorization.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.authorizations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"authorizationId": { +"description": "Required. The ID to use for the authorization, which will become the final component of the resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/authorizations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"delete": { +"description": "Deletes an Authorization.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.authorizations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` If the caller does not have permission to delete the authorization, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the authorization to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets an Authorization.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.authorizations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of Authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all Authorizations under an Engine.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.authorizations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Authorizations to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListAuthorizationsResponse.next_page_token, received from a previous AuthorizationService.ListAuthorizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuthorizations must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/authorizations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"patch": { +"description": "Updates an Authorization", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authorizations/{authorizationsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.authorizations.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +} +} +}, "cmekConfigs": { "methods": { "delete": { @@ -1282,7 +1615,7 @@ "type": "string" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -4420,6 +4753,42 @@ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] +}, +"patch": { +"description": "Update a WidgetConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] } } } @@ -4833,6 +5202,383 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] } +}, +"resources": { +"agents": { +"methods": { +"create": { +"description": "Creates an Agent.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/agents", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"delete": { +"description": "Deletes an Agent.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}` If the caller does not have permission to delete the agent, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the agent to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets an Agent.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all Agents under an Assistant which were created by the caller.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `update_time` * `is_pinned` Example: * \"update_time desc\" * \"is_pinned desc,update_time desc\": list agents by is_pinned first, then by update_time.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Maximum number of Agents to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token ListAgentsResponse.next_page_token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAgents must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/agents", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListAgentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"patch": { +"description": "Updates an Agent", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +} +}, +"resources": { +"files": { +"methods": { +"import": { +"description": "Imports a file to an Agent. Currently only No-Code agents are supported.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/files:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.assistants.agents.files.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/files:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +} +} +} +} +}, +"cannedQueries": { +"methods": { +"create": { +"description": "Creates a CannedQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"cannedQueryId": { +"description": "Required. The ID to use for the canned query, which will become the final component of the canned query's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/cannedQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"delete": { +"description": "Deletes a CannedQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` If the caller does not have permission to delete the canned query, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the canned query to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets a CannedQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Resource name of CannedQuery. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"list": { +"description": "Lists all CannedQuerys under an Assistant.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. The filter expression. Supported fields: * `enabled` * `google_defined` Examples: * `enabled=true` * `google_defined=true` * `enabled=true AND google_defined=true`", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of canned queries to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous CannedQueryService.ListCannedQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CannedQueryService.ListCannedQueries must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/cannedQueries", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"patch": { +"description": "Updates a CannedQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/cannedQueries/{cannedQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.engines.assistants.cannedQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/cannedQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +} +} +} } }, "completionConfig": { @@ -5888,6 +6634,42 @@ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] +}, +"patch": { +"description": "Update a WidgetConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] } } } @@ -6006,7 +6788,7 @@ "type": "string" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -8729,6 +9511,42 @@ "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] +}, +"patch": { +"description": "Update a WidgetConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.widgetConfigs.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] } } } @@ -10385,6 +11203,127 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] +}, +"create": { +"description": "Creates a new User Store.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userStores.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"userStoreId": { +"description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/userStores", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"delete": { +"description": "Deletes the User Store.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.userStores.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets the User Store.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userStores.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"patch": { +"description": "Updates the User Store.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.userStores.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] } }, "resources": { @@ -10595,7 +11534,7 @@ } } }, -"revision": "20251017", +"revision": "20251030", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "ApiservingMediaRequestInfo": { @@ -13050,6 +13989,12 @@ ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -14315,6 +15260,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -14347,6 +15297,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", @@ -14365,6 +15337,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -15310,6 +16286,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1UserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1UserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -15355,6 +16358,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition": { +"description": "Stored definition of an agent that uses A2A.", +"id": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition", +"properties": { +"jsonAgentCard": { +"description": "Optional. The agent card is a JSON string.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", @@ -15423,6 +16437,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition": { +"description": "Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).", +"id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition", +"properties": { +"provisionedReasoningEngine": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine", +"description": "Optional. The reasoning engine that the agent is connected to." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine": { +"description": "Keeps track of the reasoning engine that the agent is connected to. This message is not intended to keep track of agent's lifecycle. Instead it is only used to define parameters to connect to the agent that is already deployed to a reasoning engine.", +"id": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinitionProvisionedReasoningEngine", +"properties": { +"reasoningEngine": { +"description": "Required. The reasoning engine that the agent is connected to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest": { "description": "Request message for CompletionService.AdvancedCompleteQuery method. .", "id": "GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest", @@ -15485,7 +16521,7 @@ "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", "type": "string" } }, @@ -15750,6 +16786,157 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAgent": { +"description": "Performs a predefined, specific task.", +"id": "GoogleCloudDiscoveryengineV1alphaAgent", +"properties": { +"a2aAgentDefinition": { +"$ref": "GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition", +"description": "Optional. The behavior of the agent is defined as an A2A agent." +}, +"adkAgentDefinition": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAdkAgentDefinition", +"description": "Optional. The behavior of the agent is defined as an ADK agent." +}, +"authorizationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig", +"description": "Optional. The authorizations that are required by the agent." +}, +"createTime": { +"description": "Output only. Timestamp when this Agent was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customPlaceholderText": { +"description": "Optional. The custom placeholder text that appears in the text box before the user enters any text.", +"type": "string" +}, +"deploymentFailureReason": { +"description": "Output only. The reason why the agent deployment failed. Only set if the state is DEPLOYMENT_FAILED.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Required. Human-readable description of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.", +"type": "string" +}, +"dialogflowAgentDefinition": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition", +"description": "Optional. The behavior of the agent is defined as a Dialogflow agent." +}, +"displayName": { +"description": "Required. Display name of the agent. This might be used by an LLM to automatically select an agent to respond to a user query.", +"type": "string" +}, +"icon": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentImage", +"description": "Optional. The icon that represents the agent on the UI." +}, +"languageCode": { +"description": "Optional. The code of the language of the text in the description, display_name and starter_prompts fields.", +"type": "string" +}, +"name": { +"description": "Identifier. Resource name of the agent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}`", +"type": "string" +}, +"rejectionReason": { +"description": "Output only. The reason why the agent was rejected. Only set if the state is PRIVATE, and got there via rejection.", +"readOnly": true, +"type": "string" +}, +"starterPrompts": { +"description": "Optional. The starter prompt suggestions to show the user on the landing page of the agent.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt" +}, +"type": "array" +}, +"state": { +"description": "Output only. The lifecycle state of the agent.", +"enum": [ +"STATE_UNSPECIFIED", +"CONFIGURED", +"DEPLOYING", +"DISABLED", +"DEPLOYMENT_FAILED", +"PRIVATE", +"ENABLED", +"SUSPENDED" +], +"enumDescriptions": [ +"The state is unspecified.", +"The agent is configured, but no deployment triggered yet.", +"The agent is being deployed.", +"The agent is available for admins only.", +"The agent deployment failed.", +"Agent is available only to its creator..", +"Agent is available for users who have access.", +"Agent is temporarily unavailable, though visible to users who have access." +], +"readOnly": true, +"type": "string" +}, +"suspensionReason": { +"description": "Output only. The reason why the agent was suspended. Only set if the state is SUSPENDED.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when this Agent was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAgentFile": { +"description": "Describes a file used internally by an agent as a context on each invocation.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentFile", +"properties": { +"fileName": { +"description": "Required. The name of the file.", +"type": "string" +}, +"mimeType": { +"description": "Immutable. The content type of the file.", +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the file. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}/files/{file}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAgentImage": { +"description": "Represents an image.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentImage", +"properties": { +"content": { +"description": "Base64-encoded image file contents.", +"type": "string" +}, +"uri": { +"description": "Image URI.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt": { +"description": "The starter prompt suggestion to show the user on the landing page of the agent.", +"id": "GoogleCloudDiscoveryengineV1alphaAgentStarterPrompt", +"properties": { +"text": { +"description": "Required. The text of the starter prompt.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { "description": "The connector level alert config.", "id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", @@ -17745,6 +18932,73 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAuthorization": { +"description": "Discovery Engine Authorization resource.", +"id": "GoogleCloudDiscoveryengineV1alphaAuthorization", +"properties": { +"displayName": { +"description": "Required. The display name of the authorization. It must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Identifier. Resource name of the authorization. Format: `projects/{project}/locations/{location}/authorizations/{authorization}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"serverSideOauth2": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2", +"description": "Server-side OAuth2 configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAuthorizationConfig": { +"description": "Describes the authorizations required.", +"id": "GoogleCloudDiscoveryengineV1alphaAuthorizationConfig", +"properties": { +"agentAuthorization": { +"description": "Optional. The authorization that is required to invoke the agent. Auth tokens will be passed to the agent as part of the request auth header.", +"type": "string" +}, +"toolAuthorizations": { +"description": "Optional. List of required authorizations for agent to access other resources. Auth tokens will be passed to the agent as part of the request body.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2": { +"description": "OAuth2 configuration.", +"id": "GoogleCloudDiscoveryengineV1alphaAuthorizationServerSideOAuth2", +"properties": { +"authorizationUri": { +"description": "Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.", +"type": "string" +}, +"clientId": { +"description": "Required. The OAuth2 client ID.", +"type": "string" +}, +"clientSecret": { +"description": "Required. The OAuth2 client secret. Encrypted at rest.", +"type": "string" +}, +"scopes": { +"description": "Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`", +"items": { +"type": "string" +}, +"type": "array" +}, +"tokenUri": { +"description": "Required. The HTTP endpoint that exchanges a client authorization for an access token.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaBAPConfig": { "description": "The configuration for the BAP connector.", "id": "GoogleCloudDiscoveryengineV1alphaBAPConfig", @@ -18173,6 +19427,124 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig": { +"description": "Information about license configs at billing account level.", +"id": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig", +"properties": { +"autoRenew": { +"description": "Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.", +"type": "boolean" +}, +"endDate": { +"$ref": "GoogleTypeDate", +"description": "Optional. The planed subscription end date." +}, +"geminiBundle": { +"description": "Whether the license config is for Gemini bundle.", +"type": "boolean" +}, +"licenseConfigDistributions": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "A map of LicenseConfig names to the number of licenses distributed to each. The key is the full resource name of the LicenseConfig, such as `projects/{project}/locations/{location}/licenseConfigs/{license_config}`. The value is the count of licenses allocated to it.", +"type": "object" +}, +"licenseCount": { +"description": "Required. The number of licenses purchased under this billing account license config.", +"format": "int64", +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: `billingAccounts/{billing_account}/billingAccountLicenseConfigs/{billing_account_license_config}`.", +"type": "string" +}, +"procurementEntitlementId": { +"description": "The procurement entitlement id of the subscription.", +"type": "string" +}, +"startDate": { +"$ref": "GoogleTypeDate", +"description": "Required. The subscription start date." +}, +"state": { +"description": "Output only. The state of the BillingAccountLicenseConfig.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"EXPIRED", +"NOT_STARTED" +], +"enumDescriptions": [ +"The BillingAccountLicenseConfig does not exist. Default value. Do not use.", +"The BillingAccountLicenseConfig is active and being used.", +"The BillingAccountLicenseConfig has expired.", +"The BillingAccountLicenseConfig has not started yet, and its start date is in the future." +], +"readOnly": true, +"type": "string" +}, +"subscriptionDisplayName": { +"description": "The subscription display name.", +"type": "string" +}, +"subscriptionName": { +"description": "Output only. The corresponding SubV3 subscription name.", +"readOnly": true, +"type": "string" +}, +"subscriptionTerm": { +"description": "Required. The subscription term.", +"enum": [ +"SUBSCRIPTION_TERM_UNSPECIFIED", +"SUBSCRIPTION_TERM_ONE_MONTH", +"SUBSCRIPTION_TERM_ONE_YEAR", +"SUBSCRIPTION_TERM_THREE_YEARS" +], +"enumDescriptions": [ +"Default value, do not use.", +"1 month.", +"1 year.", +"3 years." +], +"type": "string" +}, +"subscriptionTier": { +"description": "Required. The subscription tier.", +"enum": [ +"SUBSCRIPTION_TIER_UNSPECIFIED", +"SUBSCRIPTION_TIER_SEARCH", +"SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT", +"SUBSCRIPTION_TIER_NOTEBOOK_LM", +"SUBSCRIPTION_TIER_FRONTLINE_WORKER", +"SUBSCRIPTION_TIER_AGENTSPACE_STARTER", +"SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS", +"SUBSCRIPTION_TIER_ENTERPRISE", +"SUBSCRIPTION_TIER_EDU", +"SUBSCRIPTION_TIER_EDU_PRO", +"SUBSCRIPTION_TIER_EDU_EMERGING", +"SUBSCRIPTION_TIER_EDU_PRO_EMERGING" +], +"enumDescriptions": [ +"Default value.", +"Search tier. Search tier can access VAIS search features and NotebookLM features.", +"Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.", +"NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.", +"Frontline worker tier.", +"Agentspace Starter tier.", +"Agentspace Business tier.", +"Enterprise tier.", +"EDU tier.", +"EDU Pro tier.", +"EDU emerging market tier.", +"EDU Pro emerging market tier." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaBranch": { "description": "A data branch that stores Documents.", "id": "GoogleCloudDiscoveryengineV1alphaBranch", @@ -18220,6 +19592,92 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCannedQuery": { +"description": "Canned query resource of Assistant. It represents a short-cut to a predefined conversation start.", +"id": "GoogleCloudDiscoveryengineV1alphaCannedQuery", +"properties": { +"defaultTexts": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts", +"description": "Required. The default (non-localized) values for the text attributes." +}, +"displayName": { +"description": "The display name of the canned query. It must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"enabled": { +"description": "Whether this canned query is enabled.", +"type": "boolean" +}, +"googleDefined": { +"description": "Output only. Whether this is a Google-defined, read-only canned query.", +"readOnly": true, +"type": "boolean" +}, +"localizedTexts": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts" +}, +"description": "Optional. The translations of the text attributes. The keys should be BCP-47 language codes.", +"type": "object" +}, +"name": { +"description": "Immutable. Resource name of the canned query. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{canned_query}` It must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"requiredCapabilities": { +"description": "Optional. The capabilities the Assistant needs to have to use this canned query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability": { +"description": "Capability of an assistant needed to use this canned query.", +"id": "GoogleCloudDiscoveryengineV1alphaCannedQueryAssistantCapability", +"properties": { +"actionName": { +"description": "The name of the action that the Assistant needs to have set up to use this canned query.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts": { +"description": "The text pieces for the canned query, which can be localized.", +"id": "GoogleCloudDiscoveryengineV1alphaCannedQueryCannedQueryTexts", +"properties": { +"prefix": { +"description": "Optional. The prefix that `suggested_prompts` should start with.", +"type": "string" +}, +"suggestedPrompts": { +"description": "Required. The prompts the canned query will offer to the user.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt" +}, +"type": "array" +}, +"title": { +"description": "Required. The title that is for the end user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt": { +"description": "A suggested prompt for the canned query.", +"id": "GoogleCloudDiscoveryengineV1alphaCannedQuerySuggestedPrompt", +"properties": { +"promptText": { +"description": "Required. The text of the suggested prompt.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { "description": "Request message for GroundedGenerationService.CheckGrounding method.", "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", @@ -20399,6 +21857,12 @@ ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -20592,6 +22056,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { +"description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", @@ -20739,6 +22220,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { +"description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", +"properties": { +"failureCount": { +"description": "The number of end users under the user store that failed to be deleted.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "The number of end users under the user store that were successfully deleted.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", @@ -20785,6 +22283,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition": { +"description": "Stored definition of an agent that uses a Dialogflow agent.", +"id": "GoogleCloudDiscoveryengineV1alphaDialogflowAgentDefinition", +"properties": { +"dialogflowAgent": { +"description": "Required. Resource name of the underlying Dialogflow Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", @@ -20814,6 +22323,42 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest": { +"description": "Request message for LicenseConfigService.DistributeLicenseConfig method.", +"id": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigRequest", +"properties": { +"licenseConfigId": { +"description": "Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.", +"type": "string" +}, +"licenseCount": { +"description": "Required. The number of licenses to distribute.", +"format": "int64", +"type": "string" +}, +"location": { +"description": "Required. The target GCP project region to distribute the license config to.", +"type": "string" +}, +"projectNumber": { +"description": "Required. The target GCP project number to distribute the license config to.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse": { +"description": "Response message for LicenseConfigService.DistributeLicenseConfig method.", +"id": "GoogleCloudDiscoveryengineV1alphaDistributeLicenseConfigResponse", +"properties": { +"licenseConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", +"description": "The updated or created LicenseConfig." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDocument": { "description": "Document captures all raw metadata information of items to be recommended or searched.", "id": "GoogleCloudDiscoveryengineV1alphaDocument", @@ -22559,6 +24104,32 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest": { +"description": "Request for the AgentService.ImportAgentFile method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportAgentFileRequest", +"properties": { +"fileName": { +"description": "Required. The name of the file.", +"type": "string" +}, +"mimeType": { +"description": "Optional. The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml. This field is required when the data source does not provide the content type.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse": { +"description": "Response for the AgentService.ImportAgentFile method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportAgentFileResponse", +"properties": { +"agentFile": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentFile", +"description": "The imported AgentFile." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", @@ -23241,6 +24812,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListAgentsResponse": { +"description": "Response message for the AgentService.ListAgents method.", +"id": "GoogleCloudDiscoveryengineV1alphaListAgentsResponse", +"properties": { +"agents": { +"description": "The agents visible to the caller under the parent Assistant.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgent" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListAgentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse": { +"description": "Response message for the AuthorizationService.ListAuthorizations method.", +"id": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse", +"properties": { +"authorizations": { +"description": "All the customer's Authorizations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAuthorization" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListAuthorizationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse": { +"description": "Response message for LicenseConfigService.ListBillingAccountLicenseConfigs method.", +"id": "GoogleCloudDiscoveryengineV1alphaListBillingAccountLicenseConfigsResponse", +"properties": { +"billingAccountLicenseConfigs": { +"description": "All BillingAccountLicenseConfigs for the given billing account.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBillingAccountLicenseConfig" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListBillingAccountLicenseConfigsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListBranchesResponse": { "description": "Response for BranchService.ListBranches method.", "id": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse", @@ -23255,6 +24880,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse": { +"description": "Response message for the CannedQueryService.ListCannedQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaListCannedQueriesResponse", +"properties": { +"cannedQueries": { +"description": "The list of CannedQuerys matching the request.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCannedQuery" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListCannedQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { "description": "Response message for ChunkService.ListChunks method.", "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", @@ -23901,6 +25544,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -23933,6 +25581,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", @@ -23951,6 +25621,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -25038,6 +26712,37 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest": { +"description": "Request message for LicenseConfigService.RetractLicenseConfig method.", +"id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest", +"properties": { +"fullRetract": { +"description": "Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.", +"type": "boolean" +}, +"licenseConfig": { +"description": "Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.", +"type": "string" +}, +"licenseCount": { +"description": "Optional. The number of licenses to retract. Only used when full_retract is false.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse": { +"description": "Response message for LicenseConfigService.RetractLicenseConfig method.", +"id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigResponse", +"properties": { +"licenseConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLicenseConfig", +"description": "The updated LicenseConfig." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", @@ -25494,7 +27199,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -28040,6 +29745,36 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest": { +"description": "Request message for the AgentService.UploadAgentFile method.", +"id": "GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest", +"properties": { +"blob": { +"$ref": "GdataMedia", +"description": "Information about the file being uploaded." +}, +"mediaRequestInfo": { +"$ref": "ApiservingMediaRequestInfo", +"description": "Media upload request metadata." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse": { +"description": "Response message for the AgentService.UploadAgentFile method.", +"id": "GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse", +"properties": { +"agentFile": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAgentFile", +"description": "The uploaded AgentFile." +}, +"mediaResponseInfo": { +"$ref": "ApiservingMediaResponseInfo", +"description": "Media upload response metadata." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest": { "description": "Request for the AssistantService.UploadSessionFile method.", "id": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest", @@ -28258,6 +29993,33 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1alphaUserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics": { "description": "Standard characteristics of a video media view.", "id": "GoogleCloudDiscoveryengineV1alphaVideoCharacteristics", @@ -28457,13 +30219,6 @@ false "description": "Whether to enable standalone web app.", "type": "boolean" }, -"experimentalFeatures": { -"additionalProperties": { -"type": "string" -}, -"description": "Allows to toggle unstable/experimental features in the widget (or web app)", -"type": "object" -}, "facetField": { "deprecated": true, "description": "The configuration and appearance of facets in the end user view.", @@ -28480,6 +30235,11 @@ false "description": "The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed.", "type": "object" }, +"geminiBundle": { +"description": "Output only. Whether the subscription is gemini bundle or not.", +"readOnly": true, +"type": "boolean" +}, "homepageSetting": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "description": "Optional. Describes the homepage settings of the widget." @@ -28830,7 +30590,7 @@ false "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSetting", "properties": { "shortcuts": { -"description": "Optional. The shortcuts to display on the homepage. LINT.IfChange(max_shortcuts_number) LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/components/widget_preview/widget_homepage_shortcut_config_form.ts:max_shortcuts_number)", +"description": "Optional. The shortcuts to display on the homepage.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigHomepageSettingShortcut" }, @@ -29010,6 +30770,10 @@ false "Display results from extractive answers field." ], "type": "string" +}, +"searchAddonSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", +"description": "Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests." } }, "type": "object" @@ -29075,6 +30839,25 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec": { +"description": "SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.", +"id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", +"properties": { +"generativeAnswerAddOnDisabled": { +"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.", +"type": "boolean" +}, +"kpiPersonalizationAddOnDisabled": { +"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.", +"type": "boolean" +}, +"semanticAddOnDisabled": { +"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", @@ -29749,6 +31532,12 @@ false ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -31212,6 +33001,11 @@ false "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -31244,6 +33038,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", @@ -31262,6 +33078,10 @@ false "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -31761,7 +33581,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -32801,6 +34621,33 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1betaUserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index b6fdbe166b..667dc2d8d8 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -656,7 +656,7 @@ "type": "string" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -4857,7 +4857,7 @@ "type": "string" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } @@ -8548,6 +8548,127 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] +}, +"create": { +"description": "Creates a new User Store.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userStores.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent collection resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"userStoreId": { +"description": "Required. The ID of the User Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/userStores", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserStore" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"delete": { +"description": "Deletes the User Store.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.userStores.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the User Store to delete. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"get": { +"description": "Gets the User Store.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userStores.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the User Store to get. Format: `projects/{project}/locations/{location}/userStores/{user_store_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] +}, +"patch": { +"description": "Updates the User Store.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.userStores.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserStore" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserStore" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite" +] } }, "resources": { @@ -8681,7 +8802,7 @@ } } }, -"revision": "20251017", +"revision": "20251030", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GdataBlobstore2Info": { @@ -10969,6 +11090,12 @@ ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -12234,6 +12361,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1Project", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -12266,6 +12398,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig", @@ -12284,6 +12438,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -13229,6 +13387,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1UserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1UserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -15865,6 +16050,12 @@ ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -16058,6 +16249,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata": { +"description": "Metadata related to the progress of the AgentService.DeleteAgent operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteAgentMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata": { "description": "Metadata related to the progress of the CmekConfigService.DeleteCmekConfig operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteCmekConfigMetadata", @@ -16205,6 +16413,23 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata": { +"description": "Metadata related to the progress of the UserStoreService.DeleteUserStore operation. This will be returned by the google.longrunning.Operation.metadata field. Delete UserStore will delete all the end users under the user store, return the number of end users successfully deleted or failed to delete in the metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata", +"properties": { +"failureCount": { +"description": "The number of end users under the user store that failed to be deleted.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "The number of end users under the user store that were successfully deleted.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaDestinationConfig": { "description": "Defines target endpoints used to connect to third-party sources.", "id": "GoogleCloudDiscoveryengineV1alphaDestinationConfig", @@ -17803,6 +18028,11 @@ "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -17835,6 +18065,28 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig", @@ -17853,6 +18105,10 @@ "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -18678,7 +18934,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -20031,7 +20287,7 @@ false "description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info." }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128", "type": "string" } }, @@ -23816,6 +24072,12 @@ false ], "type": "string" }, +"configurableBillingApproachUpdateTime": { +"description": "Output only. The timestamp when configurable_billing_approach was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -26410,6 +26672,11 @@ false "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { +"configurableBillingStatus": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", +"description": "Output only. The current status of the project's configurable billing.", +"readOnly": true +}, "createTime": { "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", @@ -26442,6 +26709,28 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus": { +"description": "Represents the currently effective configurable billing parameters. These values are derived from the customer's subscription history stored internally and reflect the thresholds actively being used for billing purposes at the time of the GetProject call. This includes the start_time of the subscription and may differ from the values in `customer_provided_config` due to billing rules (e.g., scale-downs taking effect only at the start of a new month).", +"id": "GoogleCloudDiscoveryengineV1betaProjectConfigurableBillingStatus", +"properties": { +"effectiveIndexingCoreThreshold": { +"description": "Optional. The currently effective Indexing Core threshold. This is the threshold against which Indexing Core usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"effectiveSearchQpmThreshold": { +"description": "Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.", +"format": "int64", +"type": "string" +}, +"startTime": { +"description": "Optional. The start time of the currently active billing subscription.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": { "description": "Customer provided configurations.", "id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig", @@ -26460,6 +26749,10 @@ false "modelArmorConfig": { "$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig", "description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses." +}, +"optOutNotebookSharing": { +"description": "Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.", +"type": "boolean" } }, "type": "object" @@ -27596,7 +27889,7 @@ false "type": "object" }, "userPseudoId": { -"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, @@ -30141,6 +30434,33 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserStore": { +"description": "Configures metadata that is used for End User entities.", +"id": "GoogleCloudDiscoveryengineV1betaUserStore", +"properties": { +"defaultLicenseConfig": { +"description": "Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured.", +"type": "string" +}, +"displayName": { +"description": "The display name of the User Store.", +"type": "string" +}, +"enableExpiredLicenseAutoUpdate": { +"description": "Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"enableLicenseAutoRegister": { +"description": "Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left.", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", From b952757151bf40ee3e8a29b4ba97723e839d564f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:13 +0000 Subject: [PATCH 32/70] feat(displayvideo): update the api #### displayvideo:v3 The following keys were added: - schemas.AdGroupAd.properties.adPolicy.$ref (Total Keys: 1) - schemas.AdPolicy (Total Keys: 120) #### displayvideo:v4 The following keys were added: - resources.advertisers.resources.adAssets.methods.bulkCreate (Total Keys: 13) - resources.advertisers.resources.adAssets.methods.create (Total Keys: 13) - resources.advertisers.resources.adAssets.methods.get (Total Keys: 17) - resources.advertisers.resources.adAssets.methods.list (Total Keys: 21) - resources.advertisers.resources.adAssets.methods.upload (Total Keys: 17) - resources.advertisers.resources.adGroups.resources.youtubeAssetTypes.resources.youtubeAssetAssociations.methods.create (Total Keys: 25) - resources.advertisers.resources.adGroups.resources.youtubeAssetTypes.resources.youtubeAssetAssociations.methods.delete (Total Keys: 29) - resources.advertisers.resources.adGroups.resources.youtubeAssetTypes.resources.youtubeAssetAssociations.methods.list (Total Keys: 31) - resources.advertisers.resources.lineItems.resources.youtubeAssetTypes.resources.youtubeAssetAssociations.methods.create (Total Keys: 25) - resources.advertisers.resources.lineItems.resources.youtubeAssetTypes.resources.youtubeAssetAssociations.methods.delete (Total Keys: 29) - resources.advertisers.resources.lineItems.resources.youtubeAssetTypes.resources.youtubeAssetAssociations.methods.list (Total Keys: 31) - schemas.AdAsset (Total Keys: 10) - schemas.AdGroupAd.properties.adPolicy.$ref (Total Keys: 1) - schemas.AdPolicy (Total Keys: 120) - schemas.BulkCreateAdAssetsRequest (Total Keys: 4) - schemas.BulkCreateAdAssetsResponse (Total Keys: 4) - schemas.CreateAdAssetRequest (Total Keys: 3) - schemas.ListAdAssetsResponse (Total Keys: 5) - schemas.ListYoutubeAssetAssociationsResponse (Total Keys: 5) - schemas.UploadAdAssetRequest (Total Keys: 4) - schemas.UploadAdAssetResponse (Total Keys: 3) - schemas.YoutubeAssetAssociation (Total Keys: 44) - schemas.YoutubeVideoAsset (Total Keys: 3) --- ...isplayvideo_v3.advertisers.adGroupAds.html | 270 ++- .../displayvideo_v4.advertisers.adAssets.html | 301 +++ ...isplayvideo_v4.advertisers.adGroupAds.html | 270 ++- .../displayvideo_v4.advertisers.adGroups.html | 5 + ...dvertisers.adGroups.youtubeAssetTypes.html | 91 + ...beAssetTypes.youtubeAssetAssociations.html | 298 +++ docs/dyn/displayvideo_v4.advertisers.html | 5 + ...displayvideo_v4.advertisers.lineItems.html | 5 + ...vertisers.lineItems.youtubeAssetTypes.html | 91 + ...beAssetTypes.youtubeAssetAssociations.html | 298 +++ .../documents/displayvideo.v2.json | 29 +- .../documents/displayvideo.v3.json | 602 ++++- .../documents/displayvideo.v4.json | 1927 +++++++++++++++-- 13 files changed, 3978 insertions(+), 214 deletions(-) create mode 100644 docs/dyn/displayvideo_v4.advertisers.adAssets.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.html create mode 100644 docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.html diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 00cacc3b51..569ba8b0c4 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -109,7 +109,140 @@

Method Details

{ # A single ad associated with an ad group. "adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system. - "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. + "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field. + "adPolicy": { # A single ad policy associated with an ad group ad. # The policy approval status of the ad. + "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. + "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. + "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + { # An entry describing how an ad has been identified as relating to an ad policy. + "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. + "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. + "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + }, + "helpCenterLink": "A String", # Ad policy help center link for the policy topic. + "policyDecisionType": "A String", # The source of the policy decision. + "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. + "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. + { # Details on ad serving constraints. + "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + }, + "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + }, + "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. + "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. + }, + }, + ], + "policyTopicDescription": "A String", # A short summary description of the policy topic. + "policyTopicEvidences": [ # The evidence used in the policy decision. + { # Evidence information used in the policy decision. + "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. + "owners": [ # The content or product owners that made a complaint. + "A String", + ], + }, + "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. + "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + "A String", + ], + }, + "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. + "device": "A String", # The device where visiting the URL resulted in the error. + "dnsErrorType": "A String", # The type of DNS error. + "expandedUri": "A String", # The full URL that didn't work. + "httpErrorCode": "A String", # The HTTP error code. + "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. + }, + "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. + "destinationTexts": [ # Destination text that caused the policy finding. + "A String", + ], + }, + "httpCode": 42, # HTTP code returned when the final URL was crawled. + "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. + "complaintType": "A String", # The type of complaint causing the legal removal. + "countryRestrictions": [ # The countries restricted due to the legal removal. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. + "complainant": "A String", # The entity who made the legal complaint. + }, + "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. + "lawType": "A String", # Type of law for the legal notice. + }, + "restrictedUris": [ # The urls restricted due to the legal removal. + "A String", + ], + }, + "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. + "regionalRequirementsEntries": [ # List of regional requirements. + { # Policy level regional legal violation details. + "countryRestrictions": [ # The countries restricted due to the legal policy. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "legalPolicy": "A String", # The legal policy that is being violated. + }, + ], + }, + "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. + "texts": [ # The fragments of text from the resource that caused the policy finding. + "A String", + ], + }, + "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. + "countryRestrictions": [ # Countries where the policy violation is relevant. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "owner": "A String", # The trademark content owner. + "term": "A String", # The trademark term. + }, + "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. + "websites": [ # Websites that caused the policy finding. + "A String", + ], + }, + }, + ], + "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. + }, + ], + }, "adUrls": [ # List of URLs used by the ad. { # Additional URLs related to the ad, including beacons. "type": "A String", # The type of the Ad URL. @@ -295,7 +428,140 @@

Method Details

"adGroupAds": [ # The list of ad group ads. This list will be absent if empty. { # A single ad associated with an ad group. "adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system. - "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. + "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field. + "adPolicy": { # A single ad policy associated with an ad group ad. # The policy approval status of the ad. + "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. + "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. + "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + { # An entry describing how an ad has been identified as relating to an ad policy. + "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. + "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. + "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + }, + "helpCenterLink": "A String", # Ad policy help center link for the policy topic. + "policyDecisionType": "A String", # The source of the policy decision. + "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. + "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. + { # Details on ad serving constraints. + "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + }, + "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + }, + "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. + "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. + }, + }, + ], + "policyTopicDescription": "A String", # A short summary description of the policy topic. + "policyTopicEvidences": [ # The evidence used in the policy decision. + { # Evidence information used in the policy decision. + "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. + "owners": [ # The content or product owners that made a complaint. + "A String", + ], + }, + "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. + "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + "A String", + ], + }, + "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. + "device": "A String", # The device where visiting the URL resulted in the error. + "dnsErrorType": "A String", # The type of DNS error. + "expandedUri": "A String", # The full URL that didn't work. + "httpErrorCode": "A String", # The HTTP error code. + "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. + }, + "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. + "destinationTexts": [ # Destination text that caused the policy finding. + "A String", + ], + }, + "httpCode": 42, # HTTP code returned when the final URL was crawled. + "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. + "complaintType": "A String", # The type of complaint causing the legal removal. + "countryRestrictions": [ # The countries restricted due to the legal removal. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. + "complainant": "A String", # The entity who made the legal complaint. + }, + "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. + "lawType": "A String", # Type of law for the legal notice. + }, + "restrictedUris": [ # The urls restricted due to the legal removal. + "A String", + ], + }, + "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. + "regionalRequirementsEntries": [ # List of regional requirements. + { # Policy level regional legal violation details. + "countryRestrictions": [ # The countries restricted due to the legal policy. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "legalPolicy": "A String", # The legal policy that is being violated. + }, + ], + }, + "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. + "texts": [ # The fragments of text from the resource that caused the policy finding. + "A String", + ], + }, + "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. + "countryRestrictions": [ # Countries where the policy violation is relevant. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "owner": "A String", # The trademark content owner. + "term": "A String", # The trademark term. + }, + "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. + "websites": [ # Websites that caused the policy finding. + "A String", + ], + }, + }, + ], + "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. + }, + ], + }, "adUrls": [ # List of URLs used by the ad. { # Additional URLs related to the ad, including beacons. "type": "A String", # The type of the Ad URL. diff --git a/docs/dyn/displayvideo_v4.advertisers.adAssets.html b/docs/dyn/displayvideo_v4.advertisers.adAssets.html new file mode 100644 index 0000000000..8319724af8 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adAssets.html @@ -0,0 +1,301 @@ + + + +

Display & Video 360 API . advertisers . adAssets

+

Instance Methods

+

+ bulkCreate(advertiserId, body=None, x__xgafv=None)

+

Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, body=None, x__xgafv=None)

+

Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.

+

+ get(advertiserId, adAssetId, x__xgafv=None)

+

Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.

+

+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.

+

Method Details

+
+ bulkCreate(advertiserId, body=None, x__xgafv=None) + 
Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser these ad assets belong to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for BulkCreateAdAssets.
+  "adAssets": [ # Required. Ad assets to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
+    { # A single ad asset.
+      "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+      "adAssetType": "A String", # Required. The type of the ad asset.
+      "entityStatus": "A String", # Output only. The entity status of the ad asset.
+      "name": "A String", # Identifier. The resource name of the ad asset.
+      "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+        "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+      },
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response message for BulkCreateAdAssets.
+  "adAssets": [ # The created ad assets.
+    { # A single ad asset.
+      "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+      "adAssetType": "A String", # Required. The type of the ad asset.
+      "entityStatus": "A String", # Output only. The entity status of the ad asset.
+      "name": "A String", # Identifier. The resource name of the ad asset.
+      "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+        "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+      },
+    },
+  ],
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ create(advertiserId, body=None, x__xgafv=None) + 
Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for CreateAdAsset.
+  "adAsset": { # A single ad asset. # Required. The ad asset to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
+    "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+    "adAssetType": "A String", # Required. The type of the ad asset.
+    "entityStatus": "A String", # Output only. The entity status of the ad asset.
+    "name": "A String", # Identifier. The resource name of the ad asset.
+    "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+      "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad asset.
+  "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+  "adAssetType": "A String", # Required. The type of the ad asset.
+  "entityStatus": "A String", # Output only. The entity status of the ad asset.
+  "name": "A String", # Identifier. The resource name of the ad asset.
+  "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+    "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+  },
+}
+
+ +
+ get(advertiserId, adAssetId, x__xgafv=None) + 
Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
+  adAssetId: string, Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A single ad asset.
+  "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+  "adAssetType": "A String", # Required. The type of the ad asset.
+  "entityStatus": "A String", # Output only. The entity status of the ad asset.
+  "name": "A String", # Identifier. The resource name of the ad asset.
+  "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+    "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+  },
+}
+
+ +
+ list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser the ad assets belong to. (required)
+  filter: string, Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`
+  orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `adAssetId desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response message for ListAdAssets.
+  "adAssets": [ # The list of ad assets. The list will only contain assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. This list will be absent if empty.
+    { # A single ad asset.
+      "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+      "adAssetType": "A String", # Required. The type of the ad asset.
+      "entityStatus": "A String", # Output only. The entity status of the ad asset.
+      "name": "A String", # Identifier. The resource name of the ad asset.
+      "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+        "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdAssets` method to retrieve the next page of results.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ upload(advertiserId, body=None, media_body=None, media_mime_type=None, x__xgafv=None) + 
Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser this ad asset belongs to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A request message for UploadAdAsset.
+  "adAssetType": "A String", # Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported.
+  "filename": "A String", # Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A response message for UploadAdAsset.
+  "adAsset": { # A single ad asset. # The created ad asset.
+    "adAssetId": "A String", # Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.
+    "adAssetType": "A String", # Required. The type of the ad asset.
+    "entityStatus": "A String", # Output only. The entity status of the ad asset.
+    "name": "A String", # Identifier. The resource name of the ad asset.
+    "youtubeVideoAsset": { # Data for a YouTube video ad asset. # Youtube video asset data.
+      "youtubeVideoId": "A String", # Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index 16a5eddf7a..cb12466c13 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -109,7 +109,140 @@

Method Details

{ # A single ad associated with an ad group. "adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system. - "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. + "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field. + "adPolicy": { # A single ad policy associated with an ad group ad. # The policy approval status of the ad. + "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. + "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. + "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + { # An entry describing how an ad has been identified as relating to an ad policy. + "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. + "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. + "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + }, + "helpCenterLink": "A String", # Ad policy help center link for the policy topic. + "policyDecisionType": "A String", # The source of the policy decision. + "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. + "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. + { # Details on ad serving constraints. + "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + }, + "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + }, + "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. + "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. + }, + }, + ], + "policyTopicDescription": "A String", # A short summary description of the policy topic. + "policyTopicEvidences": [ # The evidence used in the policy decision. + { # Evidence information used in the policy decision. + "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. + "owners": [ # The content or product owners that made a complaint. + "A String", + ], + }, + "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. + "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + "A String", + ], + }, + "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. + "device": "A String", # The device where visiting the URL resulted in the error. + "dnsErrorType": "A String", # The type of DNS error. + "expandedUri": "A String", # The full URL that didn't work. + "httpErrorCode": "A String", # The HTTP error code. + "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. + }, + "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. + "destinationTexts": [ # Destination text that caused the policy finding. + "A String", + ], + }, + "httpCode": 42, # HTTP code returned when the final URL was crawled. + "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. + "complaintType": "A String", # The type of complaint causing the legal removal. + "countryRestrictions": [ # The countries restricted due to the legal removal. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. + "complainant": "A String", # The entity who made the legal complaint. + }, + "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. + "lawType": "A String", # Type of law for the legal notice. + }, + "restrictedUris": [ # The urls restricted due to the legal removal. + "A String", + ], + }, + "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. + "regionalRequirementsEntries": [ # List of regional requirements. + { # Policy level regional legal violation details. + "countryRestrictions": [ # The countries restricted due to the legal policy. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "legalPolicy": "A String", # The legal policy that is being violated. + }, + ], + }, + "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. + "texts": [ # The fragments of text from the resource that caused the policy finding. + "A String", + ], + }, + "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. + "countryRestrictions": [ # Countries where the policy violation is relevant. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "owner": "A String", # The trademark content owner. + "term": "A String", # The trademark term. + }, + "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. + "websites": [ # Websites that caused the policy finding. + "A String", + ], + }, + }, + ], + "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. + }, + ], + }, "adUrls": [ # List of URLs used by the ad. { # Additional URLs related to the ad, including beacons. "type": "A String", # The type of the Ad URL. @@ -295,7 +428,140 @@

Method Details

"adGroupAds": [ # The list of ad group ads. This list will be absent if empty. { # A single ad associated with an ad group. "adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system. - "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. + "adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field. + "adPolicy": { # A single ad policy associated with an ad group ad. # The policy approval status of the ad. + "adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision. + "adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently. + "adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues. + { # An entry describing how an ad has been identified as relating to an ad policy. + "appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision. + "appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`. + "appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form. + }, + "helpCenterLink": "A String", # Ad policy help center link for the policy topic. + "policyDecisionType": "A String", # The source of the policy decision. + "policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review. + "policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc. + "policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc. + "policyTopicConstraints": [ # The serving constraints relevant to the policy decision. + { # Details on ad serving constraints. + "certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve. + "countries": [ # Countries where the ad cannot serve. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + }, + "globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. + }, + "globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country. + }, + "requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint. + "resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint. + }, + }, + ], + "policyTopicDescription": "A String", # A short summary description of the policy topic. + "policyTopicEvidences": [ # The evidence used in the policy decision. + { # Evidence information used in the policy decision. + "counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation. + "owners": [ # The content or product owners that made a complaint. + "A String", + ], + }, + "destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs. + "uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch. + "A String", + ], + }, + "destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination. + "device": "A String", # The device where visiting the URL resulted in the error. + "dnsErrorType": "A String", # The type of DNS error. + "expandedUri": "A String", # The full URL that didn't work. + "httpErrorCode": "A String", # The HTTP error code. + "lastCheckedTime": "A String", # The last time the error was seen when navigating to URL. + }, + "destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation. + "destinationTexts": [ # Destination text that caused the policy finding. + "A String", + ], + }, + "httpCode": 42, # HTTP code returned when the final URL was crawled. + "languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US". + "legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation. + "complaintType": "A String", # The type of complaint causing the legal removal. + "countryRestrictions": [ # The countries restricted due to the legal removal. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal. + "complainant": "A String", # The entity who made the legal complaint. + }, + "localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal. + "lawType": "A String", # Type of law for the legal notice. + }, + "restrictedUris": [ # The urls restricted due to the legal removal. + "A String", + ], + }, + "regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation. + "regionalRequirementsEntries": [ # List of regional requirements. + { # Policy level regional legal violation details. + "countryRestrictions": [ # The countries restricted due to the legal policy. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "legalPolicy": "A String", # The legal policy that is being violated. + }, + ], + }, + "textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad. + "texts": [ # The fragments of text from the resource that caused the policy finding. + "A String", + ], + }, + "trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation. + "countryRestrictions": [ # Countries where the policy violation is relevant. + { # Represents a country restriction. + "countryCriterionId": "A String", # The country criterion id. + "countryLabel": "A String", # Localized name for the country. May be empty. + }, + ], + "owner": "A String", # The trademark content owner. + "term": "A String", # The trademark term. + }, + "websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad. + "websites": [ # Websites that caused the policy finding. + "A String", + ], + }, + }, + ], + "policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic. + }, + ], + }, "adUrls": [ # List of URLs used by the ad. { # Additional URLs related to the ad, including beacons. "type": "A String", # The type of the Ad URL. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index f5a7be4740..b8b6846dc8 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -79,6 +79,11 @@

Instance Methods

Returns the targetingTypes Resource.

+

+ youtubeAssetTypes() +

+

Returns the youtubeAssetTypes Resource.

+

bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.html new file mode 100644 index 0000000000..29b6ecaf77 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . adGroups . youtubeAssetTypes

+

Instance Methods

+

+ youtubeAssetAssociations() +

+

Returns the youtubeAssetAssociations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.html new file mode 100644 index 0000000000..a9e268c233 --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.html @@ -0,0 +1,298 @@ + + + +

Display & Video 360 API . advertisers . adGroups . youtubeAssetTypes . youtubeAssetAssociations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, adGroupId, youtubeAssetType, body=None, linkedEntity_lineItemId=None, x__xgafv=None)

+

Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.

+

+ delete(advertiserId, adGroupId, youtubeAssetType, youtubeAssetAssociationId, linkedEntity_lineItemId=None, x__xgafv=None)

+

Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.

+

+ list(advertiserId, adGroupId, youtubeAssetType, linkedEntity_lineItemId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the YouTube asset associations linked to the given resource.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(advertiserId, adGroupId, youtubeAssetType, body=None, linkedEntity_lineItemId=None, x__xgafv=None) + 
Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
+  adGroupId: string, The ID of an ad group. (required)
+  youtubeAssetType: string, Required. The type of YouTube asset associated with the resource. (required)
+    Allowed values
+      YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
+      YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
+      YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
+      YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An association between a resource and a YouTube asset.
+  "linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
+    "affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
+      "affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
+        "chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
+          { # A chain of affiliate locations.
+            "chainId": "A String", # Required. ID of the affiliate location chain.
+          },
+        ],
+      },
+      "affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
+    },
+    "locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
+      "locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
+        "business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
+        "labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
+          "A String",
+        ],
+        "locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
+          "A String",
+        ],
+      },
+      "locationMatchingType": "A String", # Required. The matching type of this location asset filter.
+    },
+    "sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
+      "assetId": "A String", # Required. ID of the sitelink asset.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
+  "youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
+}
+
+  linkedEntity_lineItemId: string, The ID of a line item.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An association between a resource and a YouTube asset.
+  "linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
+    "affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
+      "affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
+        "chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
+          { # A chain of affiliate locations.
+            "chainId": "A String", # Required. ID of the affiliate location chain.
+          },
+        ],
+      },
+      "affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
+    },
+    "locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
+      "locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
+        "business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
+        "labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
+          "A String",
+        ],
+        "locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
+          "A String",
+        ],
+      },
+      "locationMatchingType": "A String", # Required. The matching type of this location asset filter.
+    },
+    "sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
+      "assetId": "A String", # Required. ID of the sitelink asset.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
+  "youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
+}
+
+ +
+ delete(advertiserId, adGroupId, youtubeAssetType, youtubeAssetAssociationId, linkedEntity_lineItemId=None, x__xgafv=None) + 
Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
+  adGroupId: string, The ID of an ad group. (required)
+  youtubeAssetType: string, Required. The type of YouTube asset associated with the resource. (required)
+    Allowed values
+      YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
+      YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
+      YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
+      YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
+  youtubeAssetAssociationId: string, Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. (required)
+  linkedEntity_lineItemId: string, The ID of a line item.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ list(advertiserId, adGroupId, youtubeAssetType, linkedEntity_lineItemId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists the YouTube asset associations linked to the given resource.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
+  adGroupId: string, The ID of an ad group. (required)
+  youtubeAssetType: string, Required. The type of YouTube asset being associated with the resource. (required)
+    Allowed values
+      YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
+      YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
+      YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
+      YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
+  linkedEntity_lineItemId: string, The ID of a line item.
+  orderBy: string, Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAssetAssociations` method to retrieve the next page of results.
+  "youtubeAssetAssociations": [ # The list of asset associations. This list will be absent if empty.
+    { # An association between a resource and a YouTube asset.
+      "linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
+        "affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
+          "affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
+            "chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
+              { # A chain of affiliate locations.
+                "chainId": "A String", # Required. ID of the affiliate location chain.
+              },
+            ],
+          },
+          "affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
+          "assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
+        },
+        "locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
+          "assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
+          "locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
+            "business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
+            "labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
+              "A String",
+            ],
+            "locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
+              "A String",
+            ],
+          },
+          "locationMatchingType": "A String", # Required. The matching type of this location asset filter.
+        },
+        "sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
+          "assetId": "A String", # Required. ID of the sitelink asset.
+        },
+      },
+      "name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
+      "youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.html b/docs/dyn/displayvideo_v4.advertisers.html index 8ae1bb1c56..2c991115df 100644 --- a/docs/dyn/displayvideo_v4.advertisers.html +++ b/docs/dyn/displayvideo_v4.advertisers.html @@ -74,6 +74,11 @@

Display & Video 360 API . advertisers

Instance Methods

+

+ adAssets() +

+

Returns the adAssets Resource.

+

adGroupAds()

diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index 853ff6fd24..8a3a718929 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -79,6 +79,11 @@

Instance Methods

Returns the targetingTypes Resource.

+

+ youtubeAssetTypes() +

+

Returns the youtubeAssetTypes Resource.

+

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete YouTube & Partners line items cannot be created or updated using the API.

diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.html new file mode 100644 index 0000000000..9e238b4e7a --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.html @@ -0,0 +1,91 @@ + + + +

Display & Video 360 API . advertisers . lineItems . youtubeAssetTypes

+

Instance Methods

+

+ youtubeAssetAssociations() +

+

Returns the youtubeAssetAssociations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.html new file mode 100644 index 0000000000..11d85de87b --- /dev/null +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.html @@ -0,0 +1,298 @@ + + + +

Display & Video 360 API . advertisers . lineItems . youtubeAssetTypes . youtubeAssetAssociations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(advertiserId, lineItemId, youtubeAssetType, body=None, linkedEntity_adGroupId=None, x__xgafv=None)

+

Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.

+

+ delete(advertiserId, lineItemId, youtubeAssetType, youtubeAssetAssociationId, linkedEntity_adGroupId=None, x__xgafv=None)

+

Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.

+

+ list(advertiserId, lineItemId, youtubeAssetType, linkedEntity_adGroupId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the YouTube asset associations linked to the given resource.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(advertiserId, lineItemId, youtubeAssetType, body=None, linkedEntity_adGroupId=None, x__xgafv=None) + 
Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
+  lineItemId: string, The ID of a line item. (required)
+  youtubeAssetType: string, Required. The type of YouTube asset associated with the resource. (required)
+    Allowed values
+      YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
+      YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
+      YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
+      YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An association between a resource and a YouTube asset.
+  "linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
+    "affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
+      "affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
+        "chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
+          { # A chain of affiliate locations.
+            "chainId": "A String", # Required. ID of the affiliate location chain.
+          },
+        ],
+      },
+      "affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
+    },
+    "locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
+      "locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
+        "business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
+        "labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
+          "A String",
+        ],
+        "locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
+          "A String",
+        ],
+      },
+      "locationMatchingType": "A String", # Required. The matching type of this location asset filter.
+    },
+    "sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
+      "assetId": "A String", # Required. ID of the sitelink asset.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
+  "youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
+}
+
+  linkedEntity_adGroupId: string, The ID of an ad group.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An association between a resource and a YouTube asset.
+  "linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
+    "affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
+      "affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
+        "chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
+          { # A chain of affiliate locations.
+            "chainId": "A String", # Required. ID of the affiliate location chain.
+          },
+        ],
+      },
+      "affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
+    },
+    "locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
+      "assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
+      "locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
+        "business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
+        "labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
+          "A String",
+        ],
+        "locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
+          "A String",
+        ],
+      },
+      "locationMatchingType": "A String", # Required. The matching type of this location asset filter.
+    },
+    "sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
+      "assetId": "A String", # Required. ID of the sitelink asset.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
+  "youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
+}
+
+ +
+ delete(advertiserId, lineItemId, youtubeAssetType, youtubeAssetAssociationId, linkedEntity_adGroupId=None, x__xgafv=None) + 
Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
+  lineItemId: string, The ID of a line item. (required)
+  youtubeAssetType: string, Required. The type of YouTube asset associated with the resource. (required)
+    Allowed values
+      YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
+      YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
+      YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
+      YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
+  youtubeAssetAssociationId: string, Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked. (required)
+  linkedEntity_adGroupId: string, The ID of an ad group.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ list(advertiserId, lineItemId, youtubeAssetType, linkedEntity_adGroupId=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists the YouTube asset associations linked to the given resource.
+
+Args:
+  advertiserId: string, Required. The ID of the advertiser that the linked entity belongs to. (required)
+  lineItemId: string, The ID of a line item. (required)
+  youtubeAssetType: string, Required. The type of YouTube asset being associated with the resource. (required)
+    Allowed values
+      YOUTUBE_ASSET_TYPE_UNSPECIFIED - YouTube asset type is not specified or is unknown in this version.
+      YOUTUBE_ASSET_TYPE_LOCATION - Location asset.
+      YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION - Affiliate location asset.
+      YOUTUBE_ASSET_TYPE_SITELINK - Sitelink asset.
+  linkedEntity_adGroupId: string, The ID of an ad group.
+  orderBy: string, Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.
+  pageSize: integer, Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
+  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAssetAssociations` method to retrieve the next page of results.
+  "youtubeAssetAssociations": [ # The list of asset associations. This list will be absent if empty.
+    { # An association between a resource and a YouTube asset.
+      "linkedYoutubeAsset": { # A YouTube asset linked to a resource in a YoutubeAssetAssociation. # Required. The YouTube asset associated with the resource.
+        "affiliateLocationAssetFilter": { # An asset filter that matches eligible affiliate location assets for serving. # An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`.
+          "affiliateLocationMatchingFunction": { # The matching function for an affiliate location asset filter. # Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`.
+            "chains": [ # Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.
+              { # A chain of affiliate locations.
+                "chainId": "A String", # Required. ID of the affiliate location chain.
+              },
+            ],
+          },
+          "affiliateLocationMatchingType": "A String", # Required. The matching type of this affiliate location asset filter.
+          "assetSetId": "A String", # Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.
+        },
+        "locationAssetFilter": { # An asset filter that matches eligible location assets for serving. # A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`.
+          "assetSetId": "A String", # Output only. The ID of the asset set that matches the location assets eligible for serving.
+          "locationMatchingFunction": { # The matching function for a location asset filter. # Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`.
+            "business": "A String", # Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.
+            "labels": [ # Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.
+              "A String",
+            ],
+            "locationAssetIds": [ # Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.
+              "A String",
+            ],
+          },
+          "locationMatchingType": "A String", # Required. The matching type of this location asset filter.
+        },
+        "sitelinkAsset": { # A sitelink asset. # A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`.
+          "assetId": "A String", # Required. ID of the sitelink asset.
+        },
+      },
+      "name": "A String", # Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.
+      "youtubeAssetType": "A String", # Required. The type of YouTube asset associated with the resource.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index d774c5a1f3..d98cabb464 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -9081,7 +9081,7 @@ } } }, -"revision": "20250925", +"revision": "20251027", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -12074,7 +12074,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -12094,6 +12095,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -12114,7 +12116,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -15926,12 +15929,14 @@ true "enum": [ "SUSPICIOUS_ACTIVITY_UNSPECIFIED", "SUSPICIOUS_ACTIVITY_HR", -"SUSPICIOUS_ACTIVITY_HMR" +"SUSPICIOUS_ACTIVITY_HMR", +"SUSPICIOUS_ACTIVITY_FD" ], "enumDescriptions": [ "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", "Ad Fraud - Exclude High Risk.", -"Ad Fraud - Exclude High and Moderate Risk." +"Ad Fraud - Exclude High and Moderate Risk.", +"Ad Fraud - Exclude Fraudulent Device." ], "type": "string" }, @@ -19420,7 +19425,8 @@ false "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -19440,6 +19446,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -19460,7 +19467,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -19512,7 +19520,8 @@ false "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -19532,6 +19541,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -19552,7 +19562,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 1c24e59b27..b29e48f00b 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9268,7 +9268,7 @@ } } }, -"revision": "20250925", +"revision": "20251027", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9401,8 +9401,7 @@ "AD_GROUP_FORMAT_AUDIO", "AD_GROUP_FORMAT_RESPONSIVE", "AD_GROUP_FORMAT_REACH", -"AD_GROUP_FORMAT_MASTHEAD", -"AD_GROUP_FORMAT_DEMAND_GEN" +"AD_GROUP_FORMAT_MASTHEAD" ], "enumDescriptions": [ "Format value is not specified or is unknown in this version.", @@ -9413,8 +9412,7 @@ "Non-skippable in-stream audio ads.", "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", -"Masthead Ad that is surfaced on the top slot on the YouTube homepage.", -"Demand Gen ads." +"Masthead Ad that is surfaced on the top slot on the YouTube homepage." ], "type": "string" }, @@ -9486,10 +9484,14 @@ "type": "string" }, "adGroupId": { -"description": "The unique ID of the ad group that the ad belongs to.", +"description": "The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.", "format": "int64", "type": "string" }, +"adPolicy": { +"$ref": "AdPolicy", +"description": "The policy approval status of the ad." +}, "adUrls": { "description": "List of URLs used by the ad.", "items": { @@ -9581,6 +9583,565 @@ }, "type": "object" }, +"AdPolicy": { +"description": "A single ad policy associated with an ad group ad.", +"id": "AdPolicy", +"properties": { +"adPolicyApprovalStatus": { +"description": "The policy approval status of an ad, indicating the approval decision.", +"enum": [ +"AD_POLICY_APPROVAL_STATUS_UNKNOWN", +"DISAPPROVED", +"APPROVED_LIMITED", +"APPROVED", +"AREA_OF_INTEREST_ONLY" +], +"enumDescriptions": [ +"Unknown or not specified.", +"Will not serve.", +"Will serve with restrictions.", +"Will serve without restrictions.", +"Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries." +], +"type": "string" +}, +"adPolicyReviewStatus": { +"description": "The policy review status of an ad, indicating where in the review process the ad is currently.", +"enum": [ +"AD_POLICY_REVIEW_STATUS_UNKNOWN", +"REVIEW_IN_PROGRESS", +"REVIEWED", +"UNDER_APPEAL", +"ELIGIBLE_MAY_SERVE" +], +"enumDescriptions": [ +"Unknown or not specified.", +"Currently under review.", +"Primary review complete. Other reviews may still be in progress.", +"Resubmitted for approval or a policy decision has been appealed.", +"Deemed eligible and may be serving. Further review could still follow." +], +"type": "string" +}, +"adPolicyTopicEntry": { +"description": "The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.", +"items": { +"$ref": "AdPolicyTopicEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyCriterionRestriction": { +"description": "Represents a country restriction.", +"id": "AdPolicyCriterionRestriction", +"properties": { +"countryCriterionId": { +"description": "The country criterion id.", +"format": "int64", +"type": "string" +}, +"countryLabel": { +"description": "Localized name for the country. May be empty.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicAppealInfo": { +"description": "Information on how to appeal a policy decision.", +"id": "AdPolicyTopicAppealInfo", +"properties": { +"appealFormLink": { +"description": "Only available when appeal_type is `APPEAL_FORM`.", +"type": "string" +}, +"appealType": { +"description": "Whether the decision can be appealed through a self-service appeal or an appeal form.", +"enum": [ +"AD_POLICY_APPEAL_TYPE_UNKNOWN", +"SELF_SERVICE_APPEAL", +"APPEAL_FORM" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The decision can be appealed through a self-service appeal.", +"The decision can be appealed using an appeal form." +], +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicConstraint": { +"description": "Details on ad serving constraints.", +"id": "AdPolicyTopicConstraint", +"properties": { +"certificateDomainMismatchCountryList": { +"$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"description": "Countries where the resource's domain is not covered by the certificates associated with it." +}, +"certificateMissingCountryList": { +"$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"description": "Countries where a certificate is required for serving." +}, +"countryConstraint": { +"$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"description": "Countries where the ad cannot serve." +}, +"globalCertificateDomainMismatch": { +"$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", +"description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain." +}, +"globalCertificateMissing": { +"$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", +"description": "Certificate is required to serve in any country." +}, +"requestCertificateFormLink": { +"description": "Link to the form to request a certificate for the constraint.", +"type": "string" +}, +"resellerConstraint": { +"$ref": "AdPolicyTopicConstraintAdPolicyResellerConstraint", +"description": "Reseller constraint." +} +}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyCountryConstraintList": { +"description": "A list of countries where the ad cannot serve due to policy constraints.", +"id": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"properties": { +"countries": { +"description": "Countries where the ad cannot serve.", +"items": { +"$ref": "AdPolicyCriterionRestriction" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint": { +"description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.", +"id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", +"properties": {}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint": { +"description": "Certificate is required to serve in any country.", +"id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", +"properties": {}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyResellerConstraint": { +"description": "Policy topic was constrained due to disapproval of the website for reseller purposes.", +"id": "AdPolicyTopicConstraintAdPolicyResellerConstraint", +"properties": {}, +"type": "object" +}, +"AdPolicyTopicEntry": { +"description": "An entry describing how an ad has been identified as relating to an ad policy.", +"id": "AdPolicyTopicEntry", +"properties": { +"appealInfo": { +"$ref": "AdPolicyTopicAppealInfo", +"description": "Information on how to appeal the policy decision." +}, +"helpCenterLink": { +"description": "Ad policy help center link for the policy topic.", +"type": "string" +}, +"policyDecisionType": { +"description": "The source of the policy decision.", +"enum": [ +"AD_POLICY_DECISION_TYPE_UNKNOWN", +"PURSUANT_TO_NOTICE", +"GOOGLE_INVESTIGATION" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The decision is from a legal notice, court order, or trademark content owner complaint, etc.", +"The decision is from a Google-owned investigation." +], +"type": "string" +}, +"policyEnforcementMeans": { +"description": "The policy enforcement means used in the policy review.", +"enum": [ +"AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN", +"AUTOMATED", +"HUMAN_REVIEW" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The enforcement process was fully automated.", +"A human was partially or fully involved in the decision enforcement process." +], +"type": "string" +}, +"policyLabel": { +"description": "Localized label text for policy. Examples include \"Trademarks in text\", \"Contains Alcohol\", etc.", +"type": "string" +}, +"policyTopic": { +"description": "The policy topic. Examples include \"TRADEMARKS\", \"ALCOHOL\", etc.", +"type": "string" +}, +"policyTopicConstraints": { +"description": "The serving constraints relevant to the policy decision.", +"items": { +"$ref": "AdPolicyTopicConstraint" +}, +"type": "array" +}, +"policyTopicDescription": { +"description": "A short summary description of the policy topic.", +"type": "string" +}, +"policyTopicEvidences": { +"description": "The evidence used in the policy decision.", +"items": { +"$ref": "AdPolicyTopicEvidence" +}, +"type": "array" +}, +"policyTopicType": { +"description": "How ad serving will be affected due to the relation to the ad policy topic.", +"enum": [ +"AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN", +"PROHIBITED", +"FULLY_LIMITED", +"LIMITED", +"DESCRIPTIVE", +"BROADENING", +"AREA_OF_INTEREST_ONLY" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The resource will not serve.", +"The resource will not serve in all targeted countries.", +"The resource cannot serve in some countries.", +"The resource can serve.", +"The resource can serve, and may serve beyond normal coverage.", +"The resource is constrained for all targeted countries, but may serve for users who are searching for information about the targeted countries." +], +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidence": { +"description": "Evidence information used in the policy decision.", +"id": "AdPolicyTopicEvidence", +"properties": { +"counterfeit": { +"$ref": "AdPolicyTopicEvidenceCounterfeit", +"description": "Counterfeit enforcement that caused a policy violation." +}, +"destinationMismatch": { +"$ref": "AdPolicyTopicEvidenceDestinationMismatch", +"description": "A mismatch between the ad destination URLs." +}, +"destinationNotWorking": { +"$ref": "AdPolicyTopicEvidenceDestinationNotWorking", +"description": "Information on HTTP or DNS errors related to the ad destination." +}, +"destinationTextList": { +"$ref": "AdPolicyTopicEvidenceDestinationTextList", +"description": "The text in the destination of the ad that is causing a policy violation." +}, +"httpCode": { +"description": "HTTP code returned when the final URL was crawled.", +"format": "int32", +"type": "integer" +}, +"languageCode": { +"description": "The language the ad was detected to be written in. This field uses IETF language tags, such as \"en-US\".", +"type": "string" +}, +"legalRemoval": { +"$ref": "AdPolicyTopicEvidenceLegalRemoval", +"description": "Legal related regulation enforcement that caused a policy violation." +}, +"regionalRequirements": { +"$ref": "AdPolicyTopicEvidenceRegionalRequirements", +"description": "T&S proactive enforcement that caused a policy violation." +}, +"textList": { +"$ref": "AdPolicyTopicEvidenceTextList", +"description": "List of evidence found in the text of the ad." +}, +"trademark": { +"$ref": "AdPolicyTopicEvidenceTrademark", +"description": "Trademark terms that caused a policy violation." +}, +"websiteList": { +"$ref": "AdPolicyTopicEvidenceWebsiteList", +"description": "List of websites linked with the ad." +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceCounterfeit": { +"description": "Details on the counterfeit enforcement that caused a policy violation.", +"id": "AdPolicyTopicEvidenceCounterfeit", +"properties": { +"owners": { +"description": "The content or product owners that made a complaint.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceDestinationMismatch": { +"description": "Details on a mismatch between destination URL types.", +"id": "AdPolicyTopicEvidenceDestinationMismatch", +"properties": { +"uriTypes": { +"description": "The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.", +"items": { +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN", +"DISPLAY_URL", +"FINAL_URL", +"FINAL_MOBILE_URL", +"TRACKING_URL", +"MOBILE_TRACKING_URL" +], +"enumDescriptions": [ +"Not specified or unknown.", +"The display URL.", +"The final URL.", +"The final mobile URL.", +"The tracking URL.", +"The mobile tracking URL." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceDestinationNotWorking": { +"description": "Details for on HTTP or DNS errors related to the ad destination.", +"id": "AdPolicyTopicEvidenceDestinationNotWorking", +"properties": { +"device": { +"description": "The device where visiting the URL resulted in the error.", +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN", +"DESKTOP", +"ANDROID", +"IOS" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Desktop device.", +"Android device.", +"iOS device." +], +"type": "string" +}, +"dnsErrorType": { +"description": "The type of DNS error.", +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN", +"HOSTNAME_NOT_FOUND", +"GOOGLE_CRAWLER_DNS_ISSUE" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Host name not found in DNS when fetching landing page.", +"Google could not crawl the landing page when communicating with DNS." +], +"type": "string" +}, +"expandedUri": { +"description": "The full URL that didn't work.", +"type": "string" +}, +"httpErrorCode": { +"description": "The HTTP error code.", +"format": "int64", +"type": "string" +}, +"lastCheckedTime": { +"description": "The last time the error was seen when navigating to URL.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceDestinationTextList": { +"description": "A list of destination text that violated the policy.", +"id": "AdPolicyTopicEvidenceDestinationTextList", +"properties": { +"destinationTexts": { +"description": "Destination text that caused the policy finding.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceLegalRemoval": { +"description": "Legal related regulation enforcement, either from DMCA or local legal regulation.", +"id": "AdPolicyTopicEvidenceLegalRemoval", +"properties": { +"complaintType": { +"description": "The type of complaint causing the legal removal.", +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_LEGAL_REMOVAL_COMPLAINT_TYPE_UNKNOWN", +"COPYRIGHT", +"COURT_ORDER", +"LOCAL_LEGAL" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Copyright. Only applies to DMCA.", +"Court order. Only applies to local legal.", +"Local legal regulation. Only applies to local legal." +], +"type": "string" +}, +"countryRestrictions": { +"description": "The countries restricted due to the legal removal.", +"items": { +"$ref": "AdPolicyCriterionRestriction" +}, +"type": "array" +}, +"dmca": { +"$ref": "AdPolicyTopicEvidenceLegalRemovalDmca", +"description": "Details on the DMCA regulation legal removal." +}, +"localLegal": { +"$ref": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", +"description": "Details on the local legal regulation legal removal." +}, +"restrictedUris": { +"description": "The urls restricted due to the legal removal.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceLegalRemovalDmca": { +"description": "DMCA complaint details.", +"id": "AdPolicyTopicEvidenceLegalRemovalDmca", +"properties": { +"complainant": { +"description": "The entity who made the legal complaint.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceLegalRemovalLocalLegal": { +"description": "Local legal regulation details.", +"id": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", +"properties": { +"lawType": { +"description": "Type of law for the legal notice.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceRegionalRequirements": { +"description": "Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement.", +"id": "AdPolicyTopicEvidenceRegionalRequirements", +"properties": { +"regionalRequirementsEntries": { +"description": "List of regional requirements.", +"items": { +"$ref": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry": { +"description": "Policy level regional legal violation details.", +"id": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry", +"properties": { +"countryRestrictions": { +"description": "The countries restricted due to the legal policy.", +"items": { +"$ref": "AdPolicyCriterionRestriction" +}, +"type": "array" +}, +"legalPolicy": { +"description": "The legal policy that is being violated.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceTextList": { +"description": "A list of fragments of text that violated the policy.", +"id": "AdPolicyTopicEvidenceTextList", +"properties": { +"texts": { +"description": "The fragments of text from the resource that caused the policy finding.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceTrademark": { +"description": "Trademark terms that caused a policy violation.", +"id": "AdPolicyTopicEvidenceTrademark", +"properties": { +"countryRestrictions": { +"description": "Countries where the policy violation is relevant.", +"items": { +"$ref": "AdPolicyCriterionRestriction" +}, +"type": "array" +}, +"owner": { +"description": "The trademark content owner.", +"type": "string" +}, +"term": { +"description": "The trademark term.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceWebsiteList": { +"description": "A list of websites that violated the policy.", +"id": "AdPolicyTopicEvidenceWebsiteList", +"properties": { +"websites": { +"description": "Websites that caused the policy finding.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "AdUrl": { "description": "Additional URLs related to the ad, including beacons.", "id": "AdUrl", @@ -10768,7 +11329,7 @@ "Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value.", "Video content duration. Value is stored in the contentDurationValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", "Video delivery type. Value is stored in the contentStreamTypeValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", -"Video genre id. Value is stored in the int64Value field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." +"Video genre id. Value is stored in the contentGenreIdValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." ], "type": "string" } @@ -13580,7 +14141,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -13600,6 +14162,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -13620,7 +14183,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -17893,12 +18457,14 @@ false "enum": [ "SUSPICIOUS_ACTIVITY_UNSPECIFIED", "SUSPICIOUS_ACTIVITY_HR", -"SUSPICIOUS_ACTIVITY_HMR" +"SUSPICIOUS_ACTIVITY_HMR", +"SUSPICIOUS_ACTIVITY_FD" ], "enumDescriptions": [ "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", "Ad Fraud - Exclude High Risk.", -"Ad Fraud - Exclude High and Moderate Risk." +"Ad Fraud - Exclude High and Moderate Risk.", +"Ad Fraud - Exclude Fraudulent Device." ], "type": "string" }, @@ -21506,7 +22072,8 @@ false "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21526,6 +22093,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -21546,7 +22114,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -21598,7 +22167,8 @@ false "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21618,6 +22188,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -21638,7 +22209,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 84ce5c96e0..e1964564b4 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -374,6 +374,191 @@ } }, "resources": { +"adAssets": { +"methods": { +"bulkCreate": { +"description": "Creates multiple ad assets in a single request. Returns the newly-created ad assets if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", +"flatPath": "v4/advertisers/{advertisersId}/adAssets:bulkCreate", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adAssets.bulkCreate", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser these ad assets belong to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adAssets:bulkCreate", +"request": { +"$ref": "BulkCreateAdAssetsRequest" +}, +"response": { +"$ref": "BulkCreateAdAssetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"create": { +"description": "Creates an ad asset. Returns the newly-created ad asset if successful. Only supports the creation of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", +"flatPath": "v4/advertisers/{advertisersId}/adAssets", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adAssets.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this ad asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adAssets", +"request": { +"$ref": "CreateAdAssetRequest" +}, +"response": { +"$ref": "AdAsset" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets an ad asset. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", +"flatPath": "v4/advertisers/{advertisersId}/adAssets/{adAssetsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adAssets.get", +"parameterOrder": [ +"advertiserId", +"adAssetId" +], +"parameters": { +"adAssetId": { +"description": "Required. The ID of the ad asset to fetch. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"advertiserId": { +"description": "Required. The ID of the advertiser this ad asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adAssets/{+adAssetId}", +"response": { +"$ref": "AdAsset" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists ad assets under an advertiser ID. Only supports the retrieval of assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", +"flatPath": "v4/advertisers/{advertisersId}/adAssets", +"httpMethod": "GET", +"id": "displayvideo.advertisers.adAssets.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser the ad assets belong to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { +"description": "Optional. Allows filtering of the results by ad asset fields. Supported syntax: * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `youtubeVideoAsset.youtubeVideoId` * `entityStatus` Examples: * All active YouTube video ad assets under an advertiser: `entityStatus=ENTITY_STATUS_ACTIVE`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. Acceptable values are: * `entityStatus` * `youtubeVideoAsset.youtubeVideoId` * `adAssetId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `adAssetId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdAssets` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adAssets", +"response": { +"$ref": "ListAdAssetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"upload": { +"description": "Uploads and creates an ad asset. Returns the ID of the newly-created ad asset if successful. Only supports the uploading of assets with the AdAssetType `AD_ASSET_TYPE_IMAGE`.", +"flatPath": "v4/advertisers/{advertisersId}/adAssets:uploadAdAsset", +"httpMethod": "POST", +"id": "displayvideo.advertisers.adAssets.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset" +} +} +}, +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this ad asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adAssets:uploadAdAsset", +"request": { +"$ref": "UploadAdAssetRequest" +}, +"response": { +"$ref": "UploadAdAssetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +], +"supportsMediaUpload": true +} +} +}, "adGroupAds": { "methods": { "get": { @@ -930,148 +1115,367 @@ } } } -} -} }, -"assets": { +"youtubeAssetTypes": { +"resources": { +"youtubeAssetAssociations": { "methods": { -"upload": { -"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", -"flatPath": "v4/advertisers/{advertisersId}/assets", +"create": { +"description": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", "httpMethod": "POST", -"id": "displayvideo.advertisers.assets.upload", -"mediaUpload": { -"accept": [ -"*/*" -], -"protocols": { -"simple": { -"multipart": true, -"path": "/upload/v4/advertisers/{+advertiserId}/assets" -} -} -}, +"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.create", "parameterOrder": [ -"advertiserId" +"advertiserId", +"adGroupId", +"youtubeAssetType" ], "parameters": { -"advertiserId": { -"description": "Required. The ID of the advertiser this asset belongs to.", +"adGroupId": { +"description": "The ID of an ad group.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" -} }, -"path": "v4/advertisers/{+advertiserId}/assets", -"request": { -"$ref": "CreateAssetRequest" +"advertiserId": { +"description": "Required. The ID of the advertiser that the linked entity belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" }, -"response": { -"$ref": "CreateAssetResponse" +"linkedEntity.lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "query", +"type": "string" }, -"scopes": [ -"https://www.googleapis.com/auth/display-video" +"youtubeAssetType": { +"description": "Required. The type of YouTube asset associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" ], -"supportsMediaUpload": true -} -} -}, -"campaigns": { -"methods": { -"create": { -"description": "Creates a new campaign. Returns the newly created campaign if successful.", -"flatPath": "v4/advertisers/{advertisersId}/campaigns", -"httpMethod": "POST", -"id": "displayvideo.advertisers.campaigns.create", -"parameterOrder": [ -"advertiserId" +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." ], -"parameters": { -"advertiserId": { -"description": "Output only. The unique ID of the advertiser the campaign belongs to.", -"format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/campaigns", +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", "request": { -"$ref": "Campaign" +"$ref": "YoutubeAssetAssociation" }, "response": { -"$ref": "Campaign" +"$ref": "YoutubeAssetAssociation" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/display-video-mediaplanning" +"https://www.googleapis.com/auth/display-video" ] }, "delete": { -"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", -"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"description": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}", "httpMethod": "DELETE", -"id": "displayvideo.advertisers.campaigns.delete", +"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.delete", "parameterOrder": [ "advertiserId", -"campaignId" +"adGroupId", +"youtubeAssetType", +"youtubeAssetAssociationId" ], "parameters": { +"adGroupId": { +"description": "The ID of an ad group.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, "advertiserId": { -"description": "The ID of the advertiser this campaign belongs to.", +"description": "Required. The ID of the advertiser that the linked entity belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"campaignId": { -"description": "The ID of the campaign we need to delete.", +"linkedEntity.lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "query", +"type": "string" +}, +"youtubeAssetAssociationId": { +"description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}", "response": { "$ref": "Empty" }, "scopes": [ -"https://www.googleapis.com/auth/display-video", -"https://www.googleapis.com/auth/display-video-mediaplanning" +"https://www.googleapis.com/auth/display-video" ] }, -"get": { -"description": "Gets a campaign.", -"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"list": { +"description": "Lists the YouTube asset associations linked to the given resource.", +"flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", "httpMethod": "GET", -"id": "displayvideo.advertisers.campaigns.get", +"id": "displayvideo.advertisers.adGroups.youtubeAssetTypes.youtubeAssetAssociations.list", "parameterOrder": [ "advertiserId", -"campaignId" +"adGroupId", +"youtubeAssetType" ], "parameters": { -"advertiserId": { -"description": "Required. The ID of the advertiser this campaign belongs to.", +"adGroupId": { +"description": "The ID of an ad group.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"campaignId": { -"description": "Required. The ID of the campaign to fetch.", +"advertiserId": { +"description": "Required. The ID of the advertiser that the linked entity belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" -} +}, +"linkedEntity.lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset being associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/adGroups/{+adGroupId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", +"response": { +"$ref": "ListYoutubeAssetAssociationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"assets": { +"methods": { +"upload": { +"description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", +"flatPath": "v4/advertisers/{advertisersId}/assets", +"httpMethod": "POST", +"id": "displayvideo.advertisers.assets.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v4/advertisers/{+advertiserId}/assets" +} +} +}, +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this asset belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/assets", +"request": { +"$ref": "CreateAssetRequest" +}, +"response": { +"$ref": "CreateAssetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +], +"supportsMediaUpload": true +} +} +}, +"campaigns": { +"methods": { +"create": { +"description": "Creates a new campaign. Returns the newly created campaign if successful.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns", +"httpMethod": "POST", +"id": "displayvideo.advertisers.campaigns.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Output only. The unique ID of the advertiser the campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns", +"request": { +"$ref": "Campaign" +}, +"response": { +"$ref": "Campaign" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"delete": { +"description": "Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.campaigns.delete", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "The ID of the advertiser this campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { +"description": "The ID of the campaign we need to delete.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video", +"https://www.googleapis.com/auth/display-video-mediaplanning" +] +}, +"get": { +"description": "Gets a campaign.", +"flatPath": "v4/advertisers/{advertisersId}/campaigns/{campaignsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.campaigns.get", +"parameterOrder": [ +"advertiserId", +"campaignId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the advertiser this campaign belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"campaignId": { +"description": "Required. The ID of the campaign to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} }, "path": "v4/advertisers/{+advertiserId}/campaigns/{+campaignId}", "response": { @@ -4165,93 +4569,312 @@ } } } -} -} }, -"locationLists": { +"youtubeAssetTypes": { +"resources": { +"youtubeAssetAssociations": { "methods": { "create": { -"description": "Creates a new location list. Returns the newly created location list if successful.", -"flatPath": "v4/advertisers/{advertisersId}/locationLists", +"description": "Creates a new association between the identified resource and a YouTube asset. Returns the newly-created association. *Warning:* This method is only available to an informed subset of users.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", "httpMethod": "POST", -"id": "displayvideo.advertisers.locationLists.create", +"id": "displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.create", "parameterOrder": [ -"advertiserId" +"advertiserId", +"lineItemId", +"youtubeAssetType" ], "parameters": { "advertiserId": { -"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"description": "Required. The ID of the advertiser that the linked entity belongs to.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"linkedEntity.adGroupId": { +"description": "The ID of an ad group.", "format": "int64", +"location": "query", +"type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/locationLists", +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", "request": { -"$ref": "LocationList" +"$ref": "YoutubeAssetAssociation" }, "response": { -"$ref": "LocationList" +"$ref": "YoutubeAssetAssociation" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] }, -"get": { -"description": "Gets a location list.", -"flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListsId}", -"httpMethod": "GET", -"id": "displayvideo.advertisers.locationLists.get", +"delete": { +"description": "Deletes an existing association between the identified resource and a YouTube asset. *Warning:* This method is only available to an informed subset of users.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations/{youtubeAssetAssociationsId}", +"httpMethod": "DELETE", +"id": "displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.delete", "parameterOrder": [ "advertiserId", -"locationListId" +"lineItemId", +"youtubeAssetType", +"youtubeAssetAssociationId" ], "parameters": { "advertiserId": { -"description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.", +"description": "Required. The ID of the advertiser that the linked entity belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"locationListId": { -"description": "Required. The ID of the location list to fetch.", +"lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"linkedEntity.adGroupId": { +"description": "The ID of an ad group.", "format": "int64", +"location": "query", +"type": "string" +}, +"youtubeAssetAssociationId": { +"description": "Required. The ID of the YouTube asset in the association. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: This should be the ID of the asset set linked, or 0 if the location_asset_filter or affiliate_location_asset_filter is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: This should be the ID of the sitelink asset linked.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" } }, -"path": "v4/advertisers/{+advertiserId}/locationLists/{+locationListId}", +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations/{+youtubeAssetAssociationId}", "response": { -"$ref": "LocationList" +"$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/display-video" ] }, "list": { -"description": "Lists location lists based on a given advertiser id.", -"flatPath": "v4/advertisers/{advertisersId}/locationLists", +"description": "Lists the YouTube asset associations linked to the given resource.", +"flatPath": "v4/advertisers/{advertisersId}/lineItems/{lineItemsId}/youtubeAssetTypes/{youtubeAssetTypesId}/youtubeAssetAssociations", "httpMethod": "GET", -"id": "displayvideo.advertisers.locationLists.list", +"id": "displayvideo.advertisers.lineItems.youtubeAssetTypes.youtubeAssetAssociations.list", "parameterOrder": [ -"advertiserId" +"advertiserId", +"lineItemId", +"youtubeAssetType" ], "parameters": { "advertiserId": { -"description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", +"description": "Required. The ID of the advertiser that the linked entity belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, -"filter": { +"lineItemId": { +"description": "The ID of a line item.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"linkedEntity.adGroupId": { +"description": "The ID of an ad group.", +"format": "int64", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Field by which to sort the list. The only acceptable values are: * `linkedYoutubeAsset.locationAssetFilter.assetSetId`, * `linkedYoutubeAsset.affiliateLocationAssetFilter.assetSetId`, * `linkedYoutubeAsset.sitelinkAsset.assetId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `linkedYoutubeAsset.sitelinkAsset.assetId desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListYoutubeAssetAssociations` method. If not specified, the first page of results will be returned.", +"location": "query", +"type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset being associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/lineItems/{+lineItemId}/youtubeAssetTypes/{+youtubeAssetType}/youtubeAssetAssociations", +"response": { +"$ref": "ListYoutubeAssetAssociationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +} +} +} +} +} +} +}, +"locationLists": { +"methods": { +"create": { +"description": "Creates a new location list. Returns the newly created location list if successful.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists", +"httpMethod": "POST", +"id": "displayvideo.advertisers.locationLists.create", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the location list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/locationLists", +"request": { +"$ref": "LocationList" +}, +"response": { +"$ref": "LocationList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"get": { +"description": "Gets a location list.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists/{locationListsId}", +"httpMethod": "GET", +"id": "displayvideo.advertisers.locationLists.get", +"parameterOrder": [ +"advertiserId", +"locationListId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the fetched location list belongs.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"locationListId": { +"description": "Required. The ID of the location list to fetch.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v4/advertisers/{+advertiserId}/locationLists/{+locationListId}", +"response": { +"$ref": "LocationList" +}, +"scopes": [ +"https://www.googleapis.com/auth/display-video" +] +}, +"list": { +"description": "Lists location lists based on a given advertiser id.", +"flatPath": "v4/advertisers/{advertisersId}/locationLists", +"httpMethod": "GET", +"id": "displayvideo.advertisers.locationLists.list", +"parameterOrder": [ +"advertiserId" +], +"parameters": { +"advertiserId": { +"description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", +"format": "int64", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +}, +"filter": { "description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", "location": "query", "type": "string" @@ -9302,7 +9925,7 @@ } } }, -"revision": "20250930", +"revision": "20251027", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9420,6 +10043,62 @@ }, "type": "object" }, +"AdAsset": { +"description": "A single ad asset.", +"id": "AdAsset", +"properties": { +"adAssetId": { +"description": "Output only. The ID of the ad asset. Referred to as the asset ID when assigned to an ad.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"adAssetType": { +"description": "Required. The type of the ad asset.", +"enum": [ +"AD_ASSET_TYPE_UNSPECIFIED", +"AD_ASSET_TYPE_IMAGE", +"AD_ASSET_TYPE_YOUTUBE_VIDEO" +], +"enumDescriptions": [ +"The ad asset type is unspecified.", +"The ad asset is a YouTube/DemandGen image.", +"The ad asset is a YouTube video." +], +"type": "string" +}, +"entityStatus": { +"description": "Output only. The entity status of the ad asset.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the ad asset.", +"type": "string" +}, +"youtubeVideoAsset": { +"$ref": "YoutubeVideoAsset", +"description": "Youtube video asset data." +} +}, +"type": "object" +}, "AdGroup": { "description": "A single ad group associated with a line item.", "id": "AdGroup", @@ -9435,8 +10114,7 @@ "AD_GROUP_FORMAT_AUDIO", "AD_GROUP_FORMAT_RESPONSIVE", "AD_GROUP_FORMAT_REACH", -"AD_GROUP_FORMAT_MASTHEAD", -"AD_GROUP_FORMAT_DEMAND_GEN" +"AD_GROUP_FORMAT_MASTHEAD" ], "enumDescriptions": [ "Format value is not specified or is unknown in this version.", @@ -9447,8 +10125,7 @@ "Non-skippable in-stream audio ads.", "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", -"Masthead Ad that is surfaced on the top slot on the YouTube homepage.", -"Demand Gen ads." +"Masthead Ad that is surfaced on the top slot on the YouTube homepage." ], "type": "string" }, @@ -9510,107 +10187,670 @@ }, "type": "object" }, -"AdGroupAd": { -"description": "A single ad associated with an ad group.", -"id": "AdGroupAd", +"AdGroupAd": { +"description": "A single ad associated with an ad group.", +"id": "AdGroupAd", +"properties": { +"adGroupAdId": { +"description": "The unique ID of the ad. Assigned by the system.", +"format": "int64", +"type": "string" +}, +"adGroupId": { +"description": "The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.", +"format": "int64", +"type": "string" +}, +"adPolicy": { +"$ref": "AdPolicy", +"description": "The policy approval status of the ad." +}, +"adUrls": { +"description": "List of URLs used by the ad.", +"items": { +"$ref": "AdUrl" +}, +"type": "array" +}, +"advertiserId": { +"description": "The unique ID of the advertiser the ad belongs to.", +"format": "int64", +"type": "string" +}, +"audioAd": { +"$ref": "AudioAd", +"description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." +}, +"bumperAd": { +"$ref": "BumperAd", +"description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." +}, +"displayName": { +"description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", +"type": "string" +}, +"displayVideoSourceAd": { +"$ref": "DisplayVideoSourceAd", +"description": "Details of an ad sourced from a Display & Video 360 creative." +}, +"entityStatus": { +"description": "The entity status of the ad.", +"enum": [ +"ENTITY_STATUS_UNSPECIFIED", +"ENTITY_STATUS_ACTIVE", +"ENTITY_STATUS_ARCHIVED", +"ENTITY_STATUS_DRAFT", +"ENTITY_STATUS_PAUSED", +"ENTITY_STATUS_SCHEDULED_FOR_DELETION" +], +"enumDescriptions": [ +"Default value when status is not specified or is unknown in this version.", +"The entity is enabled to bid and spend budget.", +"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", +"The entity is under draft. Bidding and budget spending are disabled.", +"Bidding and budget spending are paused for the entity.", +"The entity is scheduled for deletion." +], +"type": "string" +}, +"inStreamAd": { +"$ref": "InStreamAd", +"description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." +}, +"mastheadAd": { +"$ref": "MastheadAd", +"description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." +}, +"name": { +"description": "The resource name of the ad.", +"type": "string" +}, +"nonSkippableAd": { +"$ref": "NonSkippableAd", +"description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." +}, +"videoDiscoverAd": { +"$ref": "VideoDiscoveryAd", +"description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." +}, +"videoPerformanceAd": { +"$ref": "VideoPerformanceAd", +"description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." +} +}, +"type": "object" +}, +"AdGroupAssignedTargetingOption": { +"description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", +"id": "AdGroupAssignedTargetingOption", +"properties": { +"adGroupId": { +"description": "The ID of the ad group the assigned targeting option is assigned to.", +"format": "int64", +"type": "string" +}, +"assignedTargetingOption": { +"$ref": "AssignedTargetingOption", +"description": "The assigned targeting option resource." +} +}, +"type": "object" +}, +"AdPolicy": { +"description": "A single ad policy associated with an ad group ad.", +"id": "AdPolicy", +"properties": { +"adPolicyApprovalStatus": { +"description": "The policy approval status of an ad, indicating the approval decision.", +"enum": [ +"AD_POLICY_APPROVAL_STATUS_UNKNOWN", +"DISAPPROVED", +"APPROVED_LIMITED", +"APPROVED", +"AREA_OF_INTEREST_ONLY" +], +"enumDescriptions": [ +"Unknown or not specified.", +"Will not serve.", +"Will serve with restrictions.", +"Will serve without restrictions.", +"Will not serve in targeted countries, but may serve for users who are searching for information about the targeted countries." +], +"type": "string" +}, +"adPolicyReviewStatus": { +"description": "The policy review status of an ad, indicating where in the review process the ad is currently.", +"enum": [ +"AD_POLICY_REVIEW_STATUS_UNKNOWN", +"REVIEW_IN_PROGRESS", +"REVIEWED", +"UNDER_APPEAL", +"ELIGIBLE_MAY_SERVE" +], +"enumDescriptions": [ +"Unknown or not specified.", +"Currently under review.", +"Primary review complete. Other reviews may still be in progress.", +"Resubmitted for approval or a policy decision has been appealed.", +"Deemed eligible and may be serving. Further review could still follow." +], +"type": "string" +}, +"adPolicyTopicEntry": { +"description": "The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.", +"items": { +"$ref": "AdPolicyTopicEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyCriterionRestriction": { +"description": "Represents a country restriction.", +"id": "AdPolicyCriterionRestriction", +"properties": { +"countryCriterionId": { +"description": "The country criterion id.", +"format": "int64", +"type": "string" +}, +"countryLabel": { +"description": "Localized name for the country. May be empty.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicAppealInfo": { +"description": "Information on how to appeal a policy decision.", +"id": "AdPolicyTopicAppealInfo", +"properties": { +"appealFormLink": { +"description": "Only available when appeal_type is `APPEAL_FORM`.", +"type": "string" +}, +"appealType": { +"description": "Whether the decision can be appealed through a self-service appeal or an appeal form.", +"enum": [ +"AD_POLICY_APPEAL_TYPE_UNKNOWN", +"SELF_SERVICE_APPEAL", +"APPEAL_FORM" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The decision can be appealed through a self-service appeal.", +"The decision can be appealed using an appeal form." +], +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicConstraint": { +"description": "Details on ad serving constraints.", +"id": "AdPolicyTopicConstraint", +"properties": { +"certificateDomainMismatchCountryList": { +"$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"description": "Countries where the resource's domain is not covered by the certificates associated with it." +}, +"certificateMissingCountryList": { +"$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"description": "Countries where a certificate is required for serving." +}, +"countryConstraint": { +"$ref": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"description": "Countries where the ad cannot serve." +}, +"globalCertificateDomainMismatch": { +"$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", +"description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain." +}, +"globalCertificateMissing": { +"$ref": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", +"description": "Certificate is required to serve in any country." +}, +"requestCertificateFormLink": { +"description": "Link to the form to request a certificate for the constraint.", +"type": "string" +}, +"resellerConstraint": { +"$ref": "AdPolicyTopicConstraintAdPolicyResellerConstraint", +"description": "Reseller constraint." +} +}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyCountryConstraintList": { +"description": "A list of countries where the ad cannot serve due to policy constraints.", +"id": "AdPolicyTopicConstraintAdPolicyCountryConstraintList", +"properties": { +"countries": { +"description": "Countries where the ad cannot serve.", +"items": { +"$ref": "AdPolicyCriterionRestriction" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint": { +"description": "Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.", +"id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateDomainMismatchConstraint", +"properties": {}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint": { +"description": "Certificate is required to serve in any country.", +"id": "AdPolicyTopicConstraintAdPolicyGlobalCertificateMissingConstraint", +"properties": {}, +"type": "object" +}, +"AdPolicyTopicConstraintAdPolicyResellerConstraint": { +"description": "Policy topic was constrained due to disapproval of the website for reseller purposes.", +"id": "AdPolicyTopicConstraintAdPolicyResellerConstraint", +"properties": {}, +"type": "object" +}, +"AdPolicyTopicEntry": { +"description": "An entry describing how an ad has been identified as relating to an ad policy.", +"id": "AdPolicyTopicEntry", +"properties": { +"appealInfo": { +"$ref": "AdPolicyTopicAppealInfo", +"description": "Information on how to appeal the policy decision." +}, +"helpCenterLink": { +"description": "Ad policy help center link for the policy topic.", +"type": "string" +}, +"policyDecisionType": { +"description": "The source of the policy decision.", +"enum": [ +"AD_POLICY_DECISION_TYPE_UNKNOWN", +"PURSUANT_TO_NOTICE", +"GOOGLE_INVESTIGATION" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The decision is from a legal notice, court order, or trademark content owner complaint, etc.", +"The decision is from a Google-owned investigation." +], +"type": "string" +}, +"policyEnforcementMeans": { +"description": "The policy enforcement means used in the policy review.", +"enum": [ +"AD_POLICY_ENFORCEMENT_MEANS_UNKNOWN", +"AUTOMATED", +"HUMAN_REVIEW" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The enforcement process was fully automated.", +"A human was partially or fully involved in the decision enforcement process." +], +"type": "string" +}, +"policyLabel": { +"description": "Localized label text for policy. Examples include \"Trademarks in text\", \"Contains Alcohol\", etc.", +"type": "string" +}, +"policyTopic": { +"description": "The policy topic. Examples include \"TRADEMARKS\", \"ALCOHOL\", etc.", +"type": "string" +}, +"policyTopicConstraints": { +"description": "The serving constraints relevant to the policy decision.", +"items": { +"$ref": "AdPolicyTopicConstraint" +}, +"type": "array" +}, +"policyTopicDescription": { +"description": "A short summary description of the policy topic.", +"type": "string" +}, +"policyTopicEvidences": { +"description": "The evidence used in the policy decision.", +"items": { +"$ref": "AdPolicyTopicEvidence" +}, +"type": "array" +}, +"policyTopicType": { +"description": "How ad serving will be affected due to the relation to the ad policy topic.", +"enum": [ +"AD_POLICY_TOPIC_ENTRY_TYPE_UNKNOWN", +"PROHIBITED", +"FULLY_LIMITED", +"LIMITED", +"DESCRIPTIVE", +"BROADENING", +"AREA_OF_INTEREST_ONLY" +], +"enumDescriptions": [ +"Unknown or not specified.", +"The resource will not serve.", +"The resource will not serve in all targeted countries.", +"The resource cannot serve in some countries.", +"The resource can serve.", +"The resource can serve, and may serve beyond normal coverage.", +"The resource is constrained for all targeted countries, but may serve for users who are searching for information about the targeted countries." +], +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidence": { +"description": "Evidence information used in the policy decision.", +"id": "AdPolicyTopicEvidence", +"properties": { +"counterfeit": { +"$ref": "AdPolicyTopicEvidenceCounterfeit", +"description": "Counterfeit enforcement that caused a policy violation." +}, +"destinationMismatch": { +"$ref": "AdPolicyTopicEvidenceDestinationMismatch", +"description": "A mismatch between the ad destination URLs." +}, +"destinationNotWorking": { +"$ref": "AdPolicyTopicEvidenceDestinationNotWorking", +"description": "Information on HTTP or DNS errors related to the ad destination." +}, +"destinationTextList": { +"$ref": "AdPolicyTopicEvidenceDestinationTextList", +"description": "The text in the destination of the ad that is causing a policy violation." +}, +"httpCode": { +"description": "HTTP code returned when the final URL was crawled.", +"format": "int32", +"type": "integer" +}, +"languageCode": { +"description": "The language the ad was detected to be written in. This field uses IETF language tags, such as \"en-US\".", +"type": "string" +}, +"legalRemoval": { +"$ref": "AdPolicyTopicEvidenceLegalRemoval", +"description": "Legal related regulation enforcement that caused a policy violation." +}, +"regionalRequirements": { +"$ref": "AdPolicyTopicEvidenceRegionalRequirements", +"description": "T&S proactive enforcement that caused a policy violation." +}, +"textList": { +"$ref": "AdPolicyTopicEvidenceTextList", +"description": "List of evidence found in the text of the ad." +}, +"trademark": { +"$ref": "AdPolicyTopicEvidenceTrademark", +"description": "Trademark terms that caused a policy violation." +}, +"websiteList": { +"$ref": "AdPolicyTopicEvidenceWebsiteList", +"description": "List of websites linked with the ad." +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceCounterfeit": { +"description": "Details on the counterfeit enforcement that caused a policy violation.", +"id": "AdPolicyTopicEvidenceCounterfeit", +"properties": { +"owners": { +"description": "The content or product owners that made a complaint.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceDestinationMismatch": { +"description": "Details on a mismatch between destination URL types.", +"id": "AdPolicyTopicEvidenceDestinationMismatch", +"properties": { +"uriTypes": { +"description": "The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.", +"items": { +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_DESTINATION_MISMATCH_URL_TYPE_UNKNOWN", +"DISPLAY_URL", +"FINAL_URL", +"FINAL_MOBILE_URL", +"TRACKING_URL", +"MOBILE_TRACKING_URL" +], +"enumDescriptions": [ +"Not specified or unknown.", +"The display URL.", +"The final URL.", +"The final mobile URL.", +"The tracking URL.", +"The mobile tracking URL." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceDestinationNotWorking": { +"description": "Details for on HTTP or DNS errors related to the ad destination.", +"id": "AdPolicyTopicEvidenceDestinationNotWorking", +"properties": { +"device": { +"description": "The device where visiting the URL resulted in the error.", +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DEVICE_TYPE_UNKNOWN", +"DESKTOP", +"ANDROID", +"IOS" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Desktop device.", +"Android device.", +"iOS device." +], +"type": "string" +}, +"dnsErrorType": { +"description": "The type of DNS error.", +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_DESTINATION_NOT_WORKING_DNS_ERROR_TYPE_UNKNOWN", +"HOSTNAME_NOT_FOUND", +"GOOGLE_CRAWLER_DNS_ISSUE" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Host name not found in DNS when fetching landing page.", +"Google could not crawl the landing page when communicating with DNS." +], +"type": "string" +}, +"expandedUri": { +"description": "The full URL that didn't work.", +"type": "string" +}, +"httpErrorCode": { +"description": "The HTTP error code.", +"format": "int64", +"type": "string" +}, +"lastCheckedTime": { +"description": "The last time the error was seen when navigating to URL.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceDestinationTextList": { +"description": "A list of destination text that violated the policy.", +"id": "AdPolicyTopicEvidenceDestinationTextList", +"properties": { +"destinationTexts": { +"description": "Destination text that caused the policy finding.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceLegalRemoval": { +"description": "Legal related regulation enforcement, either from DMCA or local legal regulation.", +"id": "AdPolicyTopicEvidenceLegalRemoval", +"properties": { +"complaintType": { +"description": "The type of complaint causing the legal removal.", +"enum": [ +"AD_POLICY_TOPIC_EVIDENCE_LEGAL_REMOVAL_COMPLAINT_TYPE_UNKNOWN", +"COPYRIGHT", +"COURT_ORDER", +"LOCAL_LEGAL" +], +"enumDescriptions": [ +"Not specified or unknown.", +"Copyright. Only applies to DMCA.", +"Court order. Only applies to local legal.", +"Local legal regulation. Only applies to local legal." +], +"type": "string" +}, +"countryRestrictions": { +"description": "The countries restricted due to the legal removal.", +"items": { +"$ref": "AdPolicyCriterionRestriction" +}, +"type": "array" +}, +"dmca": { +"$ref": "AdPolicyTopicEvidenceLegalRemovalDmca", +"description": "Details on the DMCA regulation legal removal." +}, +"localLegal": { +"$ref": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", +"description": "Details on the local legal regulation legal removal." +}, +"restrictedUris": { +"description": "The urls restricted due to the legal removal.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceLegalRemovalDmca": { +"description": "DMCA complaint details.", +"id": "AdPolicyTopicEvidenceLegalRemovalDmca", +"properties": { +"complainant": { +"description": "The entity who made the legal complaint.", +"type": "string" +} +}, +"type": "object" +}, +"AdPolicyTopicEvidenceLegalRemovalLocalLegal": { +"description": "Local legal regulation details.", +"id": "AdPolicyTopicEvidenceLegalRemovalLocalLegal", "properties": { -"adGroupAdId": { -"description": "The unique ID of the ad. Assigned by the system.", -"format": "int64", +"lawType": { +"description": "Type of law for the legal notice.", "type": "string" +} }, -"adGroupId": { -"description": "The unique ID of the ad group that the ad belongs to.", -"format": "int64", -"type": "string" +"type": "object" }, -"adUrls": { -"description": "List of URLs used by the ad.", +"AdPolicyTopicEvidenceRegionalRequirements": { +"description": "Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement.", +"id": "AdPolicyTopicEvidenceRegionalRequirements", +"properties": { +"regionalRequirementsEntries": { +"description": "List of regional requirements.", "items": { -"$ref": "AdUrl" +"$ref": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry" }, "type": "array" +} }, -"advertiserId": { -"description": "The unique ID of the advertiser the ad belongs to.", -"format": "int64", -"type": "string" +"type": "object" }, -"audioAd": { -"$ref": "AudioAd", -"description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." +"AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry": { +"description": "Policy level regional legal violation details.", +"id": "AdPolicyTopicEvidenceRegionalRequirementsRegionalRequirementsEntry", +"properties": { +"countryRestrictions": { +"description": "The countries restricted due to the legal policy.", +"items": { +"$ref": "AdPolicyCriterionRestriction" }, -"bumperAd": { -"$ref": "BumperAd", -"description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." +"type": "array" }, -"displayName": { -"description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", +"legalPolicy": { +"description": "The legal policy that is being violated.", "type": "string" +} }, -"displayVideoSourceAd": { -"$ref": "DisplayVideoSourceAd", -"description": "Details of an ad sourced from a Display & Video 360 creative." +"type": "object" }, -"entityStatus": { -"description": "The entity status of the ad.", -"enum": [ -"ENTITY_STATUS_UNSPECIFIED", -"ENTITY_STATUS_ACTIVE", -"ENTITY_STATUS_ARCHIVED", -"ENTITY_STATUS_DRAFT", -"ENTITY_STATUS_PAUSED", -"ENTITY_STATUS_SCHEDULED_FOR_DELETION" -], -"enumDescriptions": [ -"Default value when status is not specified or is unknown in this version.", -"The entity is enabled to bid and spend budget.", -"The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", -"The entity is under draft. Bidding and budget spending are disabled.", -"Bidding and budget spending are paused for the entity.", -"The entity is scheduled for deletion." -], +"AdPolicyTopicEvidenceTextList": { +"description": "A list of fragments of text that violated the policy.", +"id": "AdPolicyTopicEvidenceTextList", +"properties": { +"texts": { +"description": "The fragments of text from the resource that caused the policy finding.", +"items": { "type": "string" }, -"inStreamAd": { -"$ref": "InStreamAd", -"description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." +"type": "array" +} }, -"mastheadAd": { -"$ref": "MastheadAd", -"description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." +"type": "object" }, -"name": { -"description": "The resource name of the ad.", -"type": "string" +"AdPolicyTopicEvidenceTrademark": { +"description": "Trademark terms that caused a policy violation.", +"id": "AdPolicyTopicEvidenceTrademark", +"properties": { +"countryRestrictions": { +"description": "Countries where the policy violation is relevant.", +"items": { +"$ref": "AdPolicyCriterionRestriction" }, -"nonSkippableAd": { -"$ref": "NonSkippableAd", -"description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." +"type": "array" }, -"videoDiscoverAd": { -"$ref": "VideoDiscoveryAd", -"description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." +"owner": { +"description": "The trademark content owner.", +"type": "string" }, -"videoPerformanceAd": { -"$ref": "VideoPerformanceAd", -"description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." +"term": { +"description": "The trademark term.", +"type": "string" } }, "type": "object" }, -"AdGroupAssignedTargetingOption": { -"description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", -"id": "AdGroupAssignedTargetingOption", +"AdPolicyTopicEvidenceWebsiteList": { +"description": "A list of websites that violated the policy.", +"id": "AdPolicyTopicEvidenceWebsiteList", "properties": { -"adGroupId": { -"description": "The ID of the ad group the assigned targeting option is assigned to.", -"format": "int64", +"websites": { +"description": "Websites that caused the policy finding.", +"items": { "type": "string" }, -"assignedTargetingOption": { -"$ref": "AssignedTargetingOption", -"description": "The assigned targeting option resource." +"type": "array" } }, "type": "object" @@ -10802,7 +12042,7 @@ "Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value.", "Video content duration. Value is stored in the contentDurationValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", "Video delivery type. Value is stored in the contentStreamTypeValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`.", -"Video genre id. Value is stored in the int64Value field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." +"Video genre id. Value is stored in the contentGenreIdValue field of the comparison value. The comparisonOperator field must be set to `LIST_CONTAINS`." ], "type": "string" } @@ -11798,6 +13038,34 @@ }, "type": "object" }, +"BulkCreateAdAssetsRequest": { +"description": "A request message for BulkCreateAdAssets.", +"id": "BulkCreateAdAssetsRequest", +"properties": { +"adAssets": { +"description": "Required. Ad assets to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`.", +"items": { +"$ref": "AdAsset" +}, +"type": "array" +} +}, +"type": "object" +}, +"BulkCreateAdAssetsResponse": { +"description": "A response message for BulkCreateAdAssets.", +"id": "BulkCreateAdAssetsResponse", +"properties": { +"adAssets": { +"description": "The created ad assets.", +"items": { +"$ref": "AdAsset" +}, +"type": "array" +} +}, +"type": "object" +}, "BulkEditAdvertiserAssignedTargetingOptionsRequest": { "description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", @@ -13424,6 +14692,17 @@ }, "type": "object" }, +"CreateAdAssetRequest": { +"description": "A request message for CreateAdAsset.", +"id": "CreateAdAssetRequest", +"properties": { +"adAsset": { +"$ref": "AdAsset", +"description": "Required. The ad asset to create. Only supports assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`." +} +}, +"type": "object" +}, "CreateAssetRequest": { "description": "A request message for CreateAsset.", "id": "CreateAssetRequest", @@ -13614,7 +14893,8 @@ "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -13634,6 +14914,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -13654,7 +14935,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -17943,12 +19225,14 @@ false "enum": [ "SUSPICIOUS_ACTIVITY_UNSPECIFIED", "SUSPICIOUS_ACTIVITY_HR", -"SUSPICIOUS_ACTIVITY_HMR" +"SUSPICIOUS_ACTIVITY_HMR", +"SUSPICIOUS_ACTIVITY_FD" ], "enumDescriptions": [ "This enum is only a placeholder and it doesn't specify any ad fraud prevention options.", "Ad Fraud - Exclude High Risk.", -"Ad Fraud - Exclude High and Moderate Risk." +"Ad Fraud - Exclude High and Moderate Risk.", +"Ad Fraud - Exclude Fraudulent Device." ], "type": "string" }, @@ -19230,6 +20514,24 @@ false }, "type": "object" }, +"ListAdAssetsResponse": { +"description": "A response message for ListAdAssets.", +"id": "ListAdAssetsResponse", +"properties": { +"adAssets": { +"description": "The list of ad assets. The list will only contain assets of AdAssetType `AD_ASSET_TYPE_YOUTUBE_VIDEO`. This list will be absent if empty.", +"items": { +"$ref": "AdAsset" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdAssets` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, "ListAdGroupAdsResponse": { "id": "ListAdGroupAdsResponse", "properties": { @@ -19836,6 +21138,24 @@ false }, "type": "object" }, +"ListYoutubeAssetAssociationsResponse": { +"description": "Response message for YoutubeAssetAssociationService.ListYoutubeAssetAssociations.", +"id": "ListYoutubeAssetAssociationsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListYoutubeAssetAssociations` method to retrieve the next page of results.", +"type": "string" +}, +"youtubeAssetAssociations": { +"description": "The list of asset associations. This list will be absent if empty.", +"items": { +"$ref": "YoutubeAssetAssociation" +}, +"type": "array" +} +}, +"type": "object" +}, "LocationList": { "description": "A list of locations used for targeting.", "id": "LocationList", @@ -21486,7 +22806,8 @@ false "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21506,6 +22827,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -21526,7 +22848,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -21578,7 +22901,8 @@ false "SDF_VERSION_8", "SDF_VERSION_8_1", "SDF_VERSION_9", -"SDF_VERSION_9_1" +"SDF_VERSION_9_1", +"SDF_VERSION_9_2" ], "enumDeprecated": [ false, @@ -21598,6 +22922,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -21618,7 +22943,8 @@ false "SDF version 8. Read the [v8 migration guide](/display-video/api/structured-data-file/v8-migration-guide) before migrating to this version.", "SDF version 8.1.", "SDF version 9. Read the [v9 migration guide](/display-video/api/structured-data-file/v9-migration-guide) before migrating to this version.", -"SDF version 9.1." +"SDF version 9.1.", +"SDF version 9.2." ], "type": "string" } @@ -22509,6 +23835,42 @@ false }, "type": "object" }, +"UploadAdAssetRequest": { +"description": "A request message for UploadAdAsset.", +"id": "UploadAdAssetRequest", +"properties": { +"adAssetType": { +"description": "Required. The type of the ad asset. Only `AD_ASSET_TYPE_IMAGE` is supported.", +"enum": [ +"AD_ASSET_TYPE_UNSPECIFIED", +"AD_ASSET_TYPE_IMAGE", +"AD_ASSET_TYPE_YOUTUBE_VIDEO" +], +"enumDescriptions": [ +"The ad asset type is unspecified.", +"The ad asset is a YouTube/DemandGen image.", +"The ad asset is a YouTube video." +], +"type": "string" +}, +"filename": { +"description": "Required. The filename of the ad asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.", +"type": "string" +} +}, +"type": "object" +}, +"UploadAdAssetResponse": { +"description": "A response message for UploadAdAsset.", +"id": "UploadAdAssetResponse", +"properties": { +"adAsset": { +"$ref": "AdAsset", +"description": "The created ad asset." +} +}, +"type": "object" +}, "UrlAssignedTargetingOptionDetails": { "description": "Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`.", "id": "UrlAssignedTargetingOptionDetails", @@ -23101,6 +24463,188 @@ false }, "type": "object" }, +"YoutubeAssetAssociation": { +"description": "An association between a resource and a YouTube asset.", +"id": "YoutubeAssetAssociation", +"properties": { +"linkedYoutubeAsset": { +"$ref": "YoutubeAssetAssociationLinkedYouTubeAsset", +"description": "Required. The YouTube asset associated with the resource." +}, +"name": { +"description": "Identifier. The resource name of the association. For line item-level associations: The name pattern is `advertisers/{advertiser_id}/lineItems/{line_item_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For ad group-level associations: The name pattern is `advertisers/{advertiser_id}/adGroups/{ad_group_id}/youtubeAssetTypes/{youtube_asset_type}/youtubeAssetAssociations/{youtube_asset_association_id}`. For `YOUTUBE_ASSET_TYPE_LOCATION` and `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION` associations: `youtube_asset_association_id` is the ID of the asset set linked, or 0 if the location_matching_type or affiliate_location_matching_type is `DISABLED`. For `YOUTUBE_ASSET_TYPE_SITELINK` associations: `youtube_asset_association_id` is be the ID of the sitelink asset linked.", +"type": "string" +}, +"youtubeAssetType": { +"description": "Required. The type of YouTube asset associated with the resource.", +"enum": [ +"YOUTUBE_ASSET_TYPE_UNSPECIFIED", +"YOUTUBE_ASSET_TYPE_LOCATION", +"YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION", +"YOUTUBE_ASSET_TYPE_SITELINK" +], +"enumDescriptions": [ +"YouTube asset type is not specified or is unknown in this version.", +"Location asset.", +"Affiliate location asset.", +"Sitelink asset." +], +"type": "string" +} +}, +"type": "object" +}, +"YoutubeAssetAssociationAffiliateLocationAssetFilter": { +"description": "An asset filter that matches eligible affiliate location assets for serving.", +"id": "YoutubeAssetAssociationAffiliateLocationAssetFilter", +"properties": { +"affiliateLocationMatchingFunction": { +"$ref": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction", +"description": "Optional. The matching function that determines how the affiliate location asset filter matches affiliate location assets. This field is required and can only be set for if affiliate_location_matching_type is `SELECTED_CHAINS`." +}, +"affiliateLocationMatchingType": { +"description": "Required. The matching type of this affiliate location asset filter.", +"enum": [ +"AFFILIATE_LOCATION_MATCHING_TYPE_UNSPECIFIED", +"SELECT_ALL", +"SELECTED_CHAINS", +"DISABLED" +], +"enumDescriptions": [ +"Affiliate location matching type is not specified or is unknown in this version.", +"All available affiliate location assets are eligible for serving.", +"The selected affiliate location assets can serve.", +"No affiliate location assets can serve." +], +"type": "string" +}, +"assetSetId": { +"description": "Output only. The ID of the asset set that matches the affiliate location assets eligible for serving.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain": { +"description": "A chain of affiliate locations.", +"id": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain", +"properties": { +"chainId": { +"description": "Required. ID of the affiliate location chain.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction": { +"description": "The matching function for an affiliate location asset filter.", +"id": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationMatchingFunction", +"properties": { +"chains": { +"description": "Optional. The selected affiliate location chain IDs. This field is required if affiliate_location_matching_type is `SELECTED_CHAINS`.", +"items": { +"$ref": "YoutubeAssetAssociationAffiliateLocationAssetFilterAffiliateLocationChain" +}, +"type": "array" +} +}, +"type": "object" +}, +"YoutubeAssetAssociationLinkedYouTubeAsset": { +"description": "A YouTube asset linked to a resource in a YoutubeAssetAssociation.", +"id": "YoutubeAssetAssociationLinkedYouTubeAsset", +"properties": { +"affiliateLocationAssetFilter": { +"$ref": "YoutubeAssetAssociationAffiliateLocationAssetFilter", +"description": "An affiliate location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_AFFILIATE_LOCATION`." +}, +"locationAssetFilter": { +"$ref": "YoutubeAssetAssociationLocationAssetFilter", +"description": "A location asset filter. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_LOCATION`." +}, +"sitelinkAsset": { +"$ref": "YoutubeAssetAssociationSitelinkAsset", +"description": "A sitelink asset. This can be set only when youtube_asset_type is `YOUTUBE_ASSET_TYPE_SITELINK`." +} +}, +"type": "object" +}, +"YoutubeAssetAssociationLocationAssetFilter": { +"description": "An asset filter that matches eligible location assets for serving.", +"id": "YoutubeAssetAssociationLocationAssetFilter", +"properties": { +"assetSetId": { +"description": "Output only. The ID of the asset set that matches the location assets eligible for serving.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"locationMatchingFunction": { +"$ref": "YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction", +"description": "Optional. The matching function that determines how the location asset filter matches location assets. This field is required and can only be set for if location_matching_type is `FILTER` or `SELECTED_ASSETS`." +}, +"locationMatchingType": { +"description": "Required. The matching type of this location asset filter.", +"enum": [ +"LOCATION_MATCHING_TYPE_UNSPECIFIED", +"SELECT_ALL", +"FILTER", +"SELECTED_ASSETS", +"DISABLED" +], +"enumDescriptions": [ +"Location matching type is not specified or is unknown in this version.", +"All available location assets are eligible for serving.", +"The location assets that match a provided business name and/or label filters can serve.", +"Only the selected location assets can serve.", +"No location assets can serve." +], +"type": "string" +} +}, +"type": "object" +}, +"YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction": { +"description": "The matching function for a location asset filter.", +"id": "YoutubeAssetAssociationLocationAssetFilterLocationMatchingFunction", +"properties": { +"business": { +"description": "Optional. The business name to match with. This field is optional and can only be set if location_matching_type is `FILTER`.", +"type": "string" +}, +"labels": { +"description": "Optional. The labels to match with. Labels are logically OR'ed together. This field is optional and can only be set if location_matching_type is `FILTER`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"locationAssetIds": { +"description": "Optional. The selected location asset IDs. This field is required if location_matching_type is `SELECTED_ASSETS`.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"YoutubeAssetAssociationSitelinkAsset": { +"description": "A sitelink asset.", +"id": "YoutubeAssetAssociationSitelinkAsset", +"properties": { +"assetId": { +"description": "Required. ID of the sitelink asset.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "YoutubeChannelAssignedTargetingOptionDetails": { "description": "Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.", "id": "YoutubeChannelAssignedTargetingOptionDetails", @@ -23116,6 +24660,17 @@ false }, "type": "object" }, +"YoutubeVideoAsset": { +"description": "Data for a YouTube video ad asset.", +"id": "YoutubeVideoAsset", +"properties": { +"youtubeVideoId": { +"description": "Required. The YouTube video id of the asset. This is the 11 char string value used in the YouTube video URL.", +"type": "string" +} +}, +"type": "object" +}, "YoutubeVideoAssignedTargetingOptionDetails": { "description": "Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.", "id": "YoutubeVideoAssignedTargetingOptionDetails", From c44af38454081885ad41f8e11e39e6d2b8be9250 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:13 +0000 Subject: [PATCH 33/70] feat(dlp): update the api #### dlp:v2 The following keys were deleted: - schemas.GooglePrivacyDlpV2DataSourceType.properties.dataSource.readOnly (Total Keys: 1) --- ...anizations.locations.discoveryConfigs.html | 36 +++++++++---------- ...tions.locations.fileStoreDataProfiles.html | 16 ++++----- ...nizations.locations.tableDataProfiles.html | 16 ++++----- ...2.projects.locations.discoveryConfigs.html | 36 +++++++++---------- ...jects.locations.fileStoreDataProfiles.html | 16 ++++----- ....projects.locations.tableDataProfiles.html | 16 ++++----- .../discovery_cache/documents/dlp.v2.json | 9 +++-- 7 files changed, 72 insertions(+), 73 deletions(-) diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index b5a456c77a..f120a2f7d3 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -386,7 +386,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -444,8 +444,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -743,7 +743,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -801,8 +801,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1124,7 +1124,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1182,8 +1182,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1492,7 +1492,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1550,8 +1550,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1868,7 +1868,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1926,8 +1926,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -2226,7 +2226,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -2284,8 +2284,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 77eb1f521f..f9afc37b4d 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -474,7 +474,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -532,8 +532,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -733,7 +733,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "dataStorageLocations": [ # For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. "A String", @@ -1247,7 +1247,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1305,8 +1305,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1506,7 +1506,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "dataStorageLocations": [ # For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. "A String", diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index eb770e745c..b2e19c82f9 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -474,7 +474,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -532,8 +532,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -733,7 +733,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. @@ -1191,7 +1191,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1249,8 +1249,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1450,7 +1450,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index e698b47e0d..615dc5de09 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -386,7 +386,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -444,8 +444,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -743,7 +743,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -801,8 +801,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1124,7 +1124,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1182,8 +1182,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1492,7 +1492,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1550,8 +1550,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1868,7 +1868,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1926,8 +1926,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -2226,7 +2226,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -2284,8 +2284,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 5a621b9625..9f36f819e1 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -474,7 +474,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -532,8 +532,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -733,7 +733,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "dataStorageLocations": [ # For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. "A String", @@ -1247,7 +1247,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1305,8 +1305,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1506,7 +1506,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "dataStorageLocations": [ # For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. "A String", diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index a4faa70439..77315e197f 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -474,7 +474,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -532,8 +532,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -733,7 +733,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. @@ -1191,7 +1191,7 @@

Method Details

"minAge": "A String", # Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "disabled": { # Do not profile the tables. # Disable profiling for resources that match this filter. }, @@ -1249,8 +1249,8 @@

Method Details

}, "others": { # Match discovery resources not covered by any other filter. # Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. }, - "vertexDatasetResourceReference": { # Identifies a single Vertex AI dataset. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). - "datasetResourceName": "A String", # Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project. + "vertexDatasetResourceReference": { # Identifies a single Vertex AI resource. Currently only datasets are supported. # The dataset resource to scan. Targets including this can only include one target (the target with this dataset resource reference). + "datasetResourceName": "A String", # Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}` }, }, "generationCadence": { # How often existing datasets should have their profiles refreshed. New datasets are scanned as quickly as possible depending on system capacity. # How often and when to update profiles. New datasets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. @@ -1450,7 +1450,7 @@

Method Details

"score": "A String", # The score applied to the resource. }, "dataSourceType": { # Message used to identify the type of resource being profiled. # The resource type that was profiled. - "dataSource": "A String", # Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket + "dataSource": "A String", # An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket }, "datasetId": "A String", # If the resource is BigQuery, the dataset ID. "datasetLocation": "A String", # If supported, the location where the dataset's data is stored. See https://cloud.google.com/bigquery/docs/locations for supported locations. diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index cc1d73cb22..367a9c47ef 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5123,7 +5123,7 @@ } } }, -"revision": "20251012", +"revision": "20251019", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -7032,8 +7032,7 @@ "id": "GooglePrivacyDlpV2DataSourceType", "properties": { "dataSource": { -"description": "Output only. An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket", -"readOnly": true, +"description": "An identifying string to the type of resource being profiled. Current values: * google/bigquery/table * google/project * google/sql/table * google/gcs/bucket", "type": "string" } }, @@ -13039,11 +13038,11 @@ "type": "object" }, "GooglePrivacyDlpV2VertexDatasetResourceReference": { -"description": "Identifies a single Vertex AI dataset.", +"description": "Identifies a single Vertex AI resource. Currently only datasets are supported.", "id": "GooglePrivacyDlpV2VertexDatasetResourceReference", "properties": { "datasetResourceName": { -"description": "Required. The name of the dataset resource. If set within a project-level configuration, the specified resource must be within the project.", +"description": "Required. The name of the Vertex AI resource. If set within a project-level configuration, the specified resource must be within the project. Examples: * `projects/{project}/locations/{location}/datasets/{dataset}`", "type": "string" } }, From 892d8591315553114022645b20b312d8f0b0e142 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:13 +0000 Subject: [PATCH 34/70] feat(documentai): update the api #### documentai:v1 The following keys were added: - resources.projects.resources.locations.resources.schemas.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.schemas.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.schemas.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.schemas.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.schemas.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.generate (Total Keys: 12) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.patch (Total Keys: 15) - schemas.GoogleCloudDocumentaiUiv1beta3DocumentSchema (Total Keys: 29) - schemas.GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata (Total Keys: 8) - schemas.GoogleCloudDocumentaiUiv1beta3EvaluationMetrics (Total Keys: 24) - schemas.GoogleCloudDocumentaiUiv1beta3EvaluationReference (Total Keys: 6) - schemas.GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata (Total Keys: 7) - schemas.GoogleCloudDocumentaiUiv1beta3FieldTierMetadata (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata (Total Keys: 5) - schemas.GoogleCloudDocumentaiUiv1beta3Processor (Total Keys: 77) - schemas.GoogleCloudDocumentaiUiv1beta3PropertyMetadata (Total Keys: 9) - schemas.GoogleCloudDocumentaiUiv1beta3Schema (Total Keys: 23) - schemas.GoogleCloudDocumentaiUiv1beta3SummaryOptions (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult.properties.rule.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1Documents (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1GenerateSchemaVersionRequest (Total Keys: 12) - schemas.GoogleCloudDocumentaiV1GenerateSchemaVersionResponse (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1ListSchemaVersionsResponse (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1ListSchemasResponse (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1NextSchema (Total Keys: 12) - schemas.GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig.properties.enableImageAnnotation.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1ProcessOptionsLayoutConfig.properties.enableTableAnnotation.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1Processor.properties.activeSchemaVersion.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1RawDocuments (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1SchemaGenerationHistory (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1SchemaGenerationIteration (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1SchemaVersion (Total Keys: 10) - schemas.GoogleCloudDocumentaiV1beta3DocumentSchema (Total Keys: 29) - schemas.GoogleCloudDocumentaiV1beta3EntityTypeMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1beta3EvaluationMetrics (Total Keys: 24) - schemas.GoogleCloudDocumentaiV1beta3EvaluationReference (Total Keys: 6) - schemas.GoogleCloudDocumentaiV1beta3FieldExtractionMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1beta3Processor (Total Keys: 74) - schemas.GoogleCloudDocumentaiV1beta3PropertyMetadata (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1beta3SummaryOptions (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata (Total Keys: 3) #### documentai:v1beta3 The following keys were added: - resources.projects.resources.locations.resources.schemas.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.schemas.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.schemas.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.schemas.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.schemas.methods.patch (Total Keys: 15) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.generate (Total Keys: 12) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.schemas.resources.schemaVersions.methods.patch (Total Keys: 15) - schemas.GoogleCloudDocumentaiUiv1beta3DocumentSchema (Total Keys: 29) - schemas.GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata (Total Keys: 8) - schemas.GoogleCloudDocumentaiUiv1beta3EvaluationMetrics (Total Keys: 24) - schemas.GoogleCloudDocumentaiUiv1beta3EvaluationReference (Total Keys: 6) - schemas.GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata (Total Keys: 7) - schemas.GoogleCloudDocumentaiUiv1beta3FieldTierMetadata (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata (Total Keys: 5) - schemas.GoogleCloudDocumentaiUiv1beta3Processor (Total Keys: 77) - schemas.GoogleCloudDocumentaiUiv1beta3PropertyMetadata (Total Keys: 9) - schemas.GoogleCloudDocumentaiUiv1beta3Schema (Total Keys: 23) - schemas.GoogleCloudDocumentaiUiv1beta3SummaryOptions (Total Keys: 4) - schemas.GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult.properties.rule.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3Documents (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest (Total Keys: 12) - schemas.GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse (Total Keys: 3) - schemas.GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1beta3ListSchemasResponse (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1beta3NextSchema (Total Keys: 12) - schemas.GoogleCloudDocumentaiV1beta3Processor.properties.activeSchemaVersion.type (Total Keys: 1) - schemas.GoogleCloudDocumentaiV1beta3RawDocuments (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1beta3SchemaGenerationHistory (Total Keys: 4) - schemas.GoogleCloudDocumentaiV1beta3SchemaGenerationIteration (Total Keys: 5) - schemas.GoogleCloudDocumentaiV1beta3SchemaVersion (Total Keys: 10) - schemas.GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata (Total Keys: 3) --- .../dyn/documentai_v1.projects.locations.html | 5 + ...ntai_v1.projects.locations.processors.html | 20 +- ...ocations.processors.humanReviewConfig.html | 6 +- ...ocations.processors.processorVersions.html | 16 +- ...umentai_v1.projects.locations.schemas.html | 293 ++ ...ects.locations.schemas.schemaVersions.html | 1754 ++++++++++ ...documentai_v1beta3.projects.locations.html | 5 + ...projects.locations.processors.dataset.html | 6 +- ...v1beta3.projects.locations.processors.html | 22 +- ...ocations.processors.humanReviewConfig.html | 12 +- ...ocations.processors.processorVersions.html | 18 +- ...ai_v1beta3.projects.locations.schemas.html | 293 ++ ...ects.locations.schemas.schemaVersions.html | 1920 +++++++++++ .../documents/documentai.v1.json | 2885 ++++++++++++++--- .../documents/documentai.v1beta3.json | 1686 +++++++++- 15 files changed, 8361 insertions(+), 580 deletions(-) create mode 100644 docs/dyn/documentai_v1.projects.locations.schemas.html create mode 100644 docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html create mode 100644 docs/dyn/documentai_v1beta3.projects.locations.schemas.html create mode 100644 docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html diff --git a/docs/dyn/documentai_v1.projects.locations.html b/docs/dyn/documentai_v1.projects.locations.html index babedf3258..fa5debf25d 100644 --- a/docs/dyn/documentai_v1.projects.locations.html +++ b/docs/dyn/documentai_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the processors Resource.

+

+ schemas() +

+

Returns the schemas Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index 959bc1c7ad..e528e1a491 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -167,6 +167,8 @@

Method Details

"chunkSize": 42, # Optional. The chunk sizes to use when splitting documents, in order of level. "includeAncestorHeadings": True or False, # Optional. Whether or not to include ancestor headings when splitting. }, + "enableImageAnnotation": True or False, # Optional. Whether to include image annotations in layout parser response. + "enableTableAnnotation": True or False, # Optional. Whether to include table annotations in layout parser response. "returnBoundingBoxes": True or False, # Optional. Whether to include bounding boxes in layout parser processor response. "returnImages": True or False, # Optional. Whether to include images in layout parser processor response. }, @@ -271,6 +273,7 @@

Method Details

The object takes the form of: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -298,6 +301,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -449,6 +453,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -488,6 +493,7 @@

Method Details

"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processors": [ # The list of processors. { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -867,8 +873,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -888,8 +895,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -1643,6 +1651,8 @@

Method Details

"chunkSize": 42, # Optional. The chunk sizes to use when splitting documents, in order of level. "includeAncestorHeadings": True or False, # Optional. Whether or not to include ancestor headings when splitting. }, + "enableImageAnnotation": True or False, # Optional. Whether to include image annotations in layout parser response. + "enableTableAnnotation": True or False, # Optional. Whether to include table annotations in layout parser response. "returnBoundingBoxes": True or False, # Optional. Whether to include bounding boxes in layout parser processor response. "returnImages": True or False, # Optional. Whether to include images in layout parser processor response. }, @@ -2045,8 +2055,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -2066,8 +2077,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index dc213bcf41..67d399b4dd 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -458,8 +458,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -479,8 +480,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 2dcc74d697..37baadfb56 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -162,6 +162,8 @@

Method Details

"chunkSize": 42, # Optional. The chunk sizes to use when splitting documents, in order of level. "includeAncestorHeadings": True or False, # Optional. Whether or not to include ancestor headings when splitting. }, + "enableImageAnnotation": True or False, # Optional. Whether to include image annotations in layout parser response. + "enableTableAnnotation": True or False, # Optional. Whether to include table annotations in layout parser response. "returnBoundingBoxes": True or False, # Optional. Whether to include bounding boxes in layout parser processor response. "returnImages": True or False, # Optional. Whether to include images in layout parser processor response. }, @@ -961,8 +963,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -982,8 +985,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -1737,6 +1741,8 @@

Method Details

"chunkSize": 42, # Optional. The chunk sizes to use when splitting documents, in order of level. "includeAncestorHeadings": True or False, # Optional. Whether or not to include ancestor headings when splitting. }, + "enableImageAnnotation": True or False, # Optional. Whether to include image annotations in layout parser response. + "enableTableAnnotation": True or False, # Optional. Whether to include table annotations in layout parser response. "returnBoundingBoxes": True or False, # Optional. Whether to include bounding boxes in layout parser processor response. "returnImages": True or False, # Optional. Whether to include images in layout parser processor response. }, @@ -2139,8 +2145,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -2160,8 +2167,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1.projects.locations.schemas.html b/docs/dyn/documentai_v1.projects.locations.schemas.html new file mode 100644 index 0000000000..8699c33189 --- /dev/null +++ b/docs/dyn/documentai_v1.projects.locations.schemas.html @@ -0,0 +1,293 @@ + + + +

Cloud Document AI API . projects . locations . schemas

+

Instance Methods

+

+ schemaVersions() +

+

Returns the schemaVersions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a schema.

+

+ delete(name, force=None, x__xgafv=None)

+

Deletes a schema.

+

+ get(name, x__xgafv=None)

+

Gets a schema.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Schemas.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a schema. Editable fields are: - `display_name` - `labels`

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a schema.
+
+Args:
+  parent: string, Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) + 
Deletes a schema.
+
+Args:
+  name: string, Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  force: boolean, Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a schema.
+
+Args:
+  name: string, Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists Schemas.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.
+  pageToken: string, Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSchemas.
+  "nextPageToken": "A String", # Points to the next Schema, otherwise empty.
+  "schemas": [ # The list of Schemas.
+    { # NextSchema is a collection of SchemaVersions.
+      "createTime": "A String", # Output only. The time when the Schema was created.
+      "displayName": "A String", # Optional. The user-defined name of the Schema.
+      "labels": { # Optional. The GCP labels for the Schema.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+      "updateTime": "A String", # Output only. The time when the Schema was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a schema. Editable fields are: - `display_name` - `labels`
+
+Args:
+  name: string, Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+  updateMask: string, Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html b/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html new file mode 100644 index 0000000000..2cbfaca3d6 --- /dev/null +++ b/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html @@ -0,0 +1,1754 @@ + + + +

Cloud Document AI API . projects . locations . schemas . schemaVersions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a schema version.

+

+ delete(name, x__xgafv=None)

+

Deletes a schema version.

+

+ generate(parent, body=None, x__xgafv=None)

+

Generates a schema version.

+

+ get(name, x__xgafv=None)

+

Gets a schema version.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists SchemaVersions.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a schema version. Editable fields are: - `display_name` - `labels`

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a schema version.
+
+Args:
+  parent: string, Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "displayName": "A String", # User defined name for the type.
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "displayName": "A String", # User defined name for the type.
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a schema version.
+
+Args:
+  name: string, Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ generate(parent, body=None, x__xgafv=None) + 
Generates a schema version.
+
+Args:
+  parent: string, Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateSchemaVersion.
+  "baseSchemaVersion": "A String", # The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "gcsDocuments": { # Specifies a set of documents on Cloud Storage. # The set of documents placed on Cloud Storage.
+    "documents": [ # The list of documents.
+      { # Specifies a document stored on Cloud Storage.
+        "gcsUri": "A String", # The Cloud Storage object uri.
+        "mimeType": "A String", # An IANA MIME type (RFC6838) of the content.
+      },
+    ],
+  },
+  "gcsPrefix": { # Specifies all documents on Cloud Storage with a common prefix. # The common prefix of documents placed on Cloud Storage.
+    "gcsUriPrefix": "A String", # The URI prefix.
+  },
+  "generateSchemaVersionParams": { # The parameters for the schema generation. # Optional. User specified parameters for the schema generation.
+    "history": { # The history of schema generation iterations. # Optional. Previous prompt-answers in a chronological order.
+      "iterations": [ # Required. Previous prompt-answers in a chronological order.
+        { # A single iteration of the schema generation.
+          "adjustedSchema": { # SchemaVersion is a version of the Schema which is created in SchemaGroup. # Optional. The previous schema version adjusted by the model.
+            "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+            "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+            "labels": { # Optional. The GCP labels for the SchemaVersion.
+              "a_key": "A String",
+            },
+            "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+            "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+              "description": "A String", # Description of the schema.
+              "displayName": "A String", # Display name to show to users.
+              "entityTypes": [ # Entity types of the schema.
+                { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+                  "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+                    "A String",
+                  ],
+                  "displayName": "A String", # User defined name for the type.
+                  "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+                    "values": [ # The individual values that this enum values type can include.
+                      "A String",
+                    ],
+                  },
+                  "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+                  "properties": [ # Description the nested structure, or composition of an entity.
+                    { # Defines properties that can be part of the entity type.
+                      "displayName": "A String", # User defined name for the property.
+                      "method": "A String", # Specifies how the entity's value is obtained.
+                      "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+                      "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+                      "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+                    },
+                  ],
+                },
+              ],
+              "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+                "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+                "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+                "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+                "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+              },
+            },
+          },
+          "generatedSchema": { # SchemaVersion is a version of the Schema which is created in SchemaGroup. # Required. The schema version generated by the model.
+            "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+            "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+            "labels": { # Optional. The GCP labels for the SchemaVersion.
+              "a_key": "A String",
+            },
+            "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+            "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+              "description": "A String", # Description of the schema.
+              "displayName": "A String", # Display name to show to users.
+              "entityTypes": [ # Entity types of the schema.
+                { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+                  "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+                    "A String",
+                  ],
+                  "displayName": "A String", # User defined name for the type.
+                  "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+                    "values": [ # The individual values that this enum values type can include.
+                      "A String",
+                    ],
+                  },
+                  "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+                  "properties": [ # Description the nested structure, or composition of an entity.
+                    { # Defines properties that can be part of the entity type.
+                      "displayName": "A String", # User defined name for the property.
+                      "method": "A String", # Specifies how the entity's value is obtained.
+                      "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+                      "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+                      "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+                    },
+                  ],
+                },
+              ],
+              "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+                "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+                "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+                "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+                "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+              },
+            },
+          },
+          "prompt": "A String", # Optional. The prompt used for the iteration.
+        },
+      ],
+    },
+    "prompt": "A String", # Optional. The prompt used for the schema generation.
+  },
+  "inlineDocuments": { # A set of inline documents. # The set of documents specified inline.
+    "documents": [ # The list of documents.
+      { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
+        "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
+          "chunks": [ # List of chunks.
+            { # Represents a chunk.
+              "chunkId": "A String", # ID of the chunk.
+              "content": "A String", # Text content of the chunk.
+              "pageFooters": [ # Page footers associated with the chunk.
+                { # Represents the page footer associated with the chunk.
+                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
+                    "pageEnd": 42, # Page where chunk ends in the document.
+                    "pageStart": 42, # Page where chunk starts in the document.
+                  },
+                  "text": "A String", # Footer in text format.
+                },
+              ],
+              "pageHeaders": [ # Page headers associated with the chunk.
+                { # Represents the page header associated with the chunk.
+                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
+                    "pageEnd": 42, # Page where chunk ends in the document.
+                    "pageStart": 42, # Page where chunk starts in the document.
+                  },
+                  "text": "A String", # Header in text format.
+                },
+              ],
+              "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
+                "pageEnd": 42, # Page where chunk ends in the document.
+                "pageStart": 42, # Page where chunk starts in the document.
+              },
+              "sourceBlockIds": [ # Unused.
+                "A String",
+              ],
+            },
+          ],
+        },
+        "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
+        "docid": "A String", # Optional. An internal identifier for document. Should be loggable (no PII).
+        "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
+          "blocks": [ # List of blocks in the document.
+            { # Represents a block. A block could be one of the various types (text, table, list) supported.
+              "blockId": "A String", # ID of the block.
+              "boundingBox": { # A bounding polygon for the detected image annotation. # Identifies the bounding box for the block.
+                "normalizedVertices": [ # The bounding polygon normalized vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                    "x": 3.14, # X coordinate.
+                    "y": 3.14, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+                "vertices": [ # The bounding polygon vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                    "x": 42, # X coordinate.
+                    "y": 42, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+              },
+              "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
+                "listEntries": [ # List entries that constitute a list block.
+                  { # Represents an entry in the list.
+                    "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
+                      # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
+                    ],
+                  },
+                ],
+                "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
+              },
+              "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
+                "pageEnd": 42, # Page where block ends in the document.
+                "pageStart": 42, # Page where block starts in the document.
+              },
+              "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
+                "bodyRows": [ # Body rows containing main table content.
+                  { # Represents a row in a table.
+                    "cells": [ # A table row is a list of table cells.
+                      { # Represents a cell in a table row.
+                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
+                          # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
+                        ],
+                        "colSpan": 42, # How many columns this cell spans.
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+                "caption": "A String", # Table caption/title.
+                "headerRows": [ # Header rows at the top of the table.
+                  { # Represents a row in a table.
+                    "cells": [ # A table row is a list of table cells.
+                      { # Represents a cell in a table row.
+                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
+                          # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
+                        ],
+                        "colSpan": 42, # How many columns this cell spans.
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+              },
+              "textBlock": { # Represents a text type block. # Block consisting of text content.
+                "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
+                  # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock
+                ],
+                "text": "A String", # Text content stored in the block.
+                "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
+              },
+            },
+          ],
+        },
+        "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
+          { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
+            "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
+            "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
+            "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
+            "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
+            "method": "A String", # Optional. Specifies how the entity's value is obtained.
+            "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
+              "addressValue": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
+                "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+                  "A String",
+                ],
+                "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+                "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+                "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+                "organization": "A String", # Optional. The name of the organization at the address.
+                "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+                "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+                  "A String",
+                ],
+                "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+                "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+                "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+                "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+              },
+              "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
+              "dateValue": { # 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 # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
+                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+              },
+              "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
+                "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+                "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+                "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+                "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+                "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+                "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+                  "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+                  "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+                },
+                "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+                "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+              },
+              "floatValue": 3.14, # Float value.
+              "integerValue": 42, # Integer value.
+              "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
+                "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+                "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+                "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+              },
+              "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document.
+              "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
+            },
+            "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
+              "pageRefs": [ # One or more references to visual page elements
+                { # Represents a weak reference to a page element within a document.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
+                  "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
+                  "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
+                  "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
+                },
+              ],
+            },
+            "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
+              # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
+            ],
+            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
+              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              "parents": [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  "id": 42, # The id of the parent provenance.
+                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  "revision": 42, # The index of the index into current revision's parent_ids list.
+                },
+              ],
+              "revision": 42, # The index of the revision that produced this element.
+              "type": "A String", # The type of provenance operation.
+            },
+            "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
+            "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
+              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+              "textSegments": [ # The text segments from the Document.text.
+                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                },
+              ],
+            },
+            "type": "A String", # Required. Entity type from a schema e.g. `Address`.
+          },
+        ],
+        "entitiesRevisionId": "A String", # The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
+        "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
+          { # Entity revision.
+            "entities": [ # The entities in this revision.
+              { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
+                "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
+                "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
+                "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
+                "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
+                "method": "A String", # Optional. Specifies how the entity's value is obtained.
+                "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
+                  "addressValue": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
+                    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+                      "A String",
+                    ],
+                    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+                    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+                    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+                    "organization": "A String", # Optional. The name of the organization at the address.
+                    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+                    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+                      "A String",
+                    ],
+                    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+                    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+                    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+                    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+                  },
+                  "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
+                  "dateValue": { # 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 # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
+                    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+                  },
+                  "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
+                    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+                    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+                    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+                    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+                    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+                    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+                      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+                      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+                    },
+                    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+                    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+                  },
+                  "floatValue": 3.14, # Float value.
+                  "integerValue": 42, # Integer value.
+                  "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
+                    "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+                    "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+                    "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+                  },
+                  "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document.
+                  "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
+                },
+                "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
+                  "pageRefs": [ # One or more references to visual page elements
+                    { # Represents a weak reference to a page element within a document.
+                      "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
+                        "normalizedVertices": [ # The bounding polygon normalized vertices.
+                          { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                            "x": 3.14, # X coordinate.
+                            "y": 3.14, # Y coordinate (starts from the top of the image).
+                          },
+                        ],
+                        "vertices": [ # The bounding polygon vertices.
+                          { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                            "x": 42, # X coordinate.
+                            "y": 42, # Y coordinate (starts from the top of the image).
+                          },
+                        ],
+                      },
+                      "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
+                      "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
+                      "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
+                      "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
+                    },
+                  ],
+                },
+                "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
+                  # Object with schema name: GoogleCloudDocumentaiV1DocumentEntity
+                ],
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+                "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
+                "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
+                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                  "textSegments": [ # The text segments from the Document.text.
+                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                    },
+                  ],
+                },
+                "type": "A String", # Required. Entity type from a schema e.g. `Address`.
+              },
+            ],
+            "entityValidationOutput": { # The output of the validation given the document and the validation rules. # The entity validation output for this revision.
+              "passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid.
+              "validationResults": [ # The result of each validation rule.
+                { # Validation result for a single validation rule.
+                  "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`
+                  "ruleDescription": "A String", # The description of the validation rule.
+                  "ruleName": "A String", # The display name of the validation rule.
+                  "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule.
+                  "validationResultType": "A String", # The result of the validation rule.
+                },
+              ],
+            },
+            "revisionId": "A String", # The revision id.
+          },
+        ],
+        "entityRelations": [ # Placeholder. Relationship among Document.entities.
+          { # Relationship between Entities.
+            "objectId": "A String", # Object entity id.
+            "relation": "A String", # Relationship description.
+            "subjectId": "A String", # Subject entity id.
+          },
+        ],
+        "entityValidationOutput": { # The output of the validation given the document and the validation rules. # The entity validation output for the document. This is the validation output for `document.entities` field.
+          "passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid.
+          "validationResults": [ # The result of each validation rule.
+            { # Validation result for a single validation rule.
+              "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`
+              "ruleDescription": "A String", # The description of the validation rule.
+              "ruleName": "A String", # The display name of the validation rule.
+              "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule.
+              "validationResultType": "A String", # The result of the validation rule.
+            },
+          ],
+        },
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
+        "pages": [ # Visual page layout for the Document.
+          { # A page in a Document.
+            "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
+              { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "detectedBarcodes": [ # A list of detected barcodes.
+              { # A detected barcode.
+                "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
+                  "format": "A String", # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.
+                  "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
+                  "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.
+                },
+                "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+              },
+            ],
+            "detectedLanguages": [ # A list of detected languages together with confidence.
+              { # Detected language for a structural component.
+                "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+              },
+            ],
+            "dimension": { # Dimension for the page. # Physical dimension of the page.
+              "height": 3.14, # Page height.
+              "unit": "A String", # Dimension unit.
+              "width": 3.14, # Page width.
+            },
+            "formFields": [ # A list of visually detected form fields on the page.
+              { # A form field detected on the page.
+                "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
+                "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
+                "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+                "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
+              },
+            ],
+            "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
+              "content": "A String", # Raw byte content of the image.
+              "height": 42, # Height of the image in pixels.
+              "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
+              "width": 42, # Width of the image in pixels.
+            },
+            "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
+              "detectedDefects": [ # A list of detected defects.
+                { # Image Quality Defects
+                  "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
+                  "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
+                },
+              ],
+              "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
+            },
+            "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
+              "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                "normalizedVertices": [ # The bounding polygon normalized vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                    "x": 3.14, # X coordinate.
+                    "y": 3.14, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+                "vertices": [ # The bounding polygon vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                    "x": 42, # X coordinate.
+                    "y": 42, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+              },
+              "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+              "orientation": "A String", # Detected orientation for the Layout.
+              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                "textSegments": [ # The text segments from the Document.text.
+                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                  },
+                ],
+              },
+            },
+            "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
+              { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
+            "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
+              { # A collection of lines that a human would perceive as a paragraph.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
+              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              "parents": [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  "id": 42, # The id of the parent provenance.
+                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  "revision": 42, # The index of the index into current revision's parent_ids list.
+                },
+              ],
+              "revision": 42, # The index of the revision that produced this element.
+              "type": "A String", # The type of provenance operation.
+            },
+            "symbols": [ # A list of visually detected symbols on the page.
+              { # A detected symbol.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+              },
+            ],
+            "tables": [ # A list of visually detected tables on the page.
+              { # A table representation similar to HTML table structure.
+                "bodyRows": [ # Body rows of the table.
+                  { # A row of table cells.
+                    "cells": [ # Cells that make up this row.
+                      { # A cell representation inside the table.
+                        "colSpan": 42, # How many columns this cell spans.
+                        "detectedLanguages": [ # A list of detected languages together with confidence.
+                          { # Detected language for a structural component.
+                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                          },
+                        ],
+                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
+                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                            "normalizedVertices": [ # The bounding polygon normalized vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                                "x": 3.14, # X coordinate.
+                                "y": 3.14, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                            "vertices": [ # The bounding polygon vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                                "x": 42, # X coordinate.
+                                "y": 42, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                          },
+                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                          "orientation": "A String", # Detected orientation for the Layout.
+                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                            "textSegments": [ # The text segments from the Document.text.
+                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                              },
+                            ],
+                          },
+                        },
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "headerRows": [ # Header rows of the table.
+                  { # A row of table cells.
+                    "cells": [ # Cells that make up this row.
+                      { # A cell representation inside the table.
+                        "colSpan": 42, # How many columns this cell spans.
+                        "detectedLanguages": [ # A list of detected languages together with confidence.
+                          { # Detected language for a structural component.
+                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                          },
+                        ],
+                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
+                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                            "normalizedVertices": [ # The bounding polygon normalized vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                                "x": 3.14, # X coordinate.
+                                "y": 3.14, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                            "vertices": [ # The bounding polygon vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                                "x": 42, # X coordinate.
+                                "y": 42, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                          },
+                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                          "orientation": "A String", # Detected orientation for the Layout.
+                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                            "textSegments": [ # The text segments from the Document.text.
+                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                              },
+                            ],
+                          },
+                        },
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "tokens": [ # A list of visually detected tokens on the page.
+              { # A detected token.
+                "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
+                  "type": "A String", # Detected break type.
+                },
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+                "styleInfo": { # Font and other text style attributes. # Text style attributes.
+                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
+                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                  },
+                  "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
+                  "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
+                  "fontType": "A String", # Name or style of the font.
+                  "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
+                  "handwritten": True or False, # Whether the text is handwritten.
+                  "italic": True or False, # Whether the text is italic.
+                  "letterSpacing": 3.14, # Letter spacing in points.
+                  "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
+                  "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
+                  "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
+                  "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
+                  "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
+                  "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
+                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                  },
+                  "underlined": True or False, # Whether the text is underlined.
+                },
+              },
+            ],
+            "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
+              { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
+                "cols": 42, # Number of columns in the matrix.
+                "data": "A String", # The matrix data.
+                "rows": 42, # Number of rows in the matrix.
+                "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
+              },
+            ],
+            "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
+              { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "type": "A String", # Type of the VisualElement.
+              },
+            ],
+          },
+        ],
+        "revisions": [ # Placeholder. Revision history of this document.
+          { # Contains past or forward revisions of this document.
+            "agent": "A String", # If the change was made by a person specify the name or id of that person.
+            "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
+            "humanReview": { # Human Review information of the document. # Human Review information of this revision.
+              "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
+              "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
+            },
+            "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
+            "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
+              42,
+            ],
+            "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
+              "A String",
+            ],
+            "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
+          },
+        ],
+        "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+          "shardCount": "A String", # Total number of shards.
+          "shardIndex": "A String", # The 0-based index of this shard.
+          "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
+        },
+        "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
+        "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
+          { # This message is used for text changes aka. OCR corrections.
+            "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
+            "provenance": [ # The history of this annotation.
+              { # Structure to identify provenance relationships between annotations in different revisions.
+                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                "parents": [ # References to the original elements that are replaced.
+                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                    "id": 42, # The id of the parent provenance.
+                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                    "revision": 42, # The index of the index into current revision's parent_ids list.
+                  },
+                ],
+                "revision": 42, # The index of the revision that produced this element.
+                "type": "A String", # The type of provenance operation.
+              },
+            ],
+            "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
+              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+              "textSegments": [ # The text segments from the Document.text.
+                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                },
+              ],
+            },
+          },
+        ],
+        "textStyles": [ # Styles for the Document.text.
+          { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
+            "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
+              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+            },
+            "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
+              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+            },
+            "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
+            "fontSize": { # Font size with unit. # Font size.
+              "size": 3.14, # Font size for the text.
+              "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
+            },
+            "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
+            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+              "textSegments": [ # The text segments from the Document.text.
+                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                },
+              ],
+            },
+            "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
+            "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
+          },
+        ],
+        "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
+      },
+    ],
+  },
+  "rawDocuments": { # Specifies a set of raw documents. # The set of raw documents.
+    "documents": [ # Specifies raw document content and mime type.
+      { # Payload message of raw document content (bytes).
+        "content": "A String", # Inline document content.
+        "displayName": "A String", # The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated.
+        "mimeType": "A String", # An IANA MIME type (RFC6838) indicating the nature and format of the content.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for GenerateSchemaVersion.
+  "schemaVersion": { # SchemaVersion is a version of the Schema which is created in SchemaGroup. # The schema version generated by the model.
+    "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+    "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+    "labels": { # Optional. The GCP labels for the SchemaVersion.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+    "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+      "description": "A String", # Description of the schema.
+      "displayName": "A String", # Display name to show to users.
+      "entityTypes": [ # Entity types of the schema.
+        { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+          "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+            "A String",
+          ],
+          "displayName": "A String", # User defined name for the type.
+          "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+            "values": [ # The individual values that this enum values type can include.
+              "A String",
+            ],
+          },
+          "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+          "properties": [ # Description the nested structure, or composition of an entity.
+            { # Defines properties that can be part of the entity type.
+              "displayName": "A String", # User defined name for the property.
+              "method": "A String", # Specifies how the entity's value is obtained.
+              "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+              "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+              "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+            },
+          ],
+        },
+      ],
+      "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+        "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+        "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+        "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+        "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+      },
+    },
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a schema version.
+
+Args:
+  name: string, Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "displayName": "A String", # User defined name for the type.
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists SchemaVersions.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  pageSize: integer, Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.
+  pageToken: string, Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSchemaVersions.
+  "nextPageToken": "A String", # Points to the next SchemaVersion, otherwise empty.
+  "schemaVersions": [ # The list of SchemaVersions.
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+      "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+      "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+      "labels": { # Optional. The GCP labels for the SchemaVersion.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+      "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+        "description": "A String", # Description of the schema.
+        "displayName": "A String", # Display name to show to users.
+        "entityTypes": [ # Entity types of the schema.
+          { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+            "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+              "A String",
+            ],
+            "displayName": "A String", # User defined name for the type.
+            "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+              "values": [ # The individual values that this enum values type can include.
+                "A String",
+              ],
+            },
+            "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+            "properties": [ # Description the nested structure, or composition of an entity.
+              { # Defines properties that can be part of the entity type.
+                "displayName": "A String", # User defined name for the property.
+                "method": "A String", # Specifies how the entity's value is obtained.
+                "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+                "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+                "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+              },
+            ],
+          },
+        ],
+        "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+          "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+          "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+          "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+          "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+        },
+      },
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a schema version. Editable fields are: - `display_name` - `labels`
+
+Args:
+  name: string, Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "displayName": "A String", # User defined name for the type.
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+  updateMask: string, Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "displayName": "A String", # User defined name for the type.
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/documentai_v1beta3.projects.locations.html b/docs/dyn/documentai_v1beta3.projects.locations.html index 61892218ae..b75055287e 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the processors Resource.

+

+ schemas() +

+

Returns the schemas Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html index ff35d8bb75..61c42dce70 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html @@ -632,8 +632,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -653,8 +654,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 6e3619b2d2..00868e1aea 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -308,6 +308,7 @@

Method Details

The object takes the form of: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -335,6 +336,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -486,6 +488,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -525,6 +528,7 @@

Method Details

"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processors": [ # The list of processors. { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -938,8 +942,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -959,8 +964,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -2072,8 +2078,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -2093,8 +2100,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -3310,8 +3318,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -3331,8 +3340,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index d3513dfa50..b6931c2f3b 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -464,8 +464,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -485,8 +486,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -1640,8 +1642,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -1661,8 +1664,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 7152de3f67..33a1fc0898 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -1101,8 +1101,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -1122,8 +1123,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -2235,8 +2237,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -2256,8 +2259,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -3473,8 +3477,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, @@ -3494,8 +3499,9 @@

Method Details

"passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid. "validationResults": [ # The result of each validation rule. { # Validation result for a single validation rule. + "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}` "ruleDescription": "A String", # The description of the validation rule. - "ruleName": "A String", # The name of the validation rule. + "ruleName": "A String", # The display name of the validation rule. "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule. "validationResultType": "A String", # The result of the validation rule. }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.schemas.html b/docs/dyn/documentai_v1beta3.projects.locations.schemas.html new file mode 100644 index 0000000000..191d5d1b0f --- /dev/null +++ b/docs/dyn/documentai_v1beta3.projects.locations.schemas.html @@ -0,0 +1,293 @@ + + + +

Cloud Document AI API . projects . locations . schemas

+

Instance Methods

+

+ schemaVersions() +

+

Returns the schemaVersions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a schema.

+

+ delete(name, force=None, x__xgafv=None)

+

Deletes a schema.

+

+ get(name, x__xgafv=None)

+

Gets a schema.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Schemas.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a schema. Editable fields are: - `display_name` - `labels`

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a schema.
+
+Args:
+  parent: string, Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) + 
Deletes a schema.
+
+Args:
+  name: string, Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  force: boolean, Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a schema.
+
+Args:
+  name: string, Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists Schemas.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}` (required)
+  pageSize: integer, Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.
+  pageToken: string, Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSchemas.
+  "nextPageToken": "A String", # Points to the next Schema, otherwise empty.
+  "schemas": [ # The list of Schemas.
+    { # NextSchema is a collection of SchemaVersions.
+      "createTime": "A String", # Output only. The time when the Schema was created.
+      "displayName": "A String", # Optional. The user-defined name of the Schema.
+      "labels": { # Optional. The GCP labels for the Schema.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+      "updateTime": "A String", # Output only. The time when the Schema was last updated.
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a schema. Editable fields are: - `display_name` - `labels`
+
+Args:
+  name: string, Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+  updateMask: string, Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NextSchema is a collection of SchemaVersions.
+  "createTime": "A String", # Output only. The time when the Schema was created.
+  "displayName": "A String", # Optional. The user-defined name of the Schema.
+  "labels": { # Optional. The GCP labels for the Schema.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`
+  "updateTime": "A String", # Output only. The time when the Schema was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html new file mode 100644 index 0000000000..84f420aee3 --- /dev/null +++ b/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html @@ -0,0 +1,1920 @@ + + + +

Cloud Document AI API . projects . locations . schemas . schemaVersions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a schema version.

+

+ delete(name, x__xgafv=None)

+

Deletes a schema version.

+

+ generate(parent, body=None, x__xgafv=None)

+

Generates a schema version.

+

+ get(name, x__xgafv=None)

+

Gets a schema version.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists SchemaVersions.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates a schema version. Editable fields are: - `display_name` - `labels`

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) + 
Creates a schema version.
+
+Args:
+  parent: string, Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+        "displayName": "A String", # User defined name for the type.
+        "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+          "inactive": True or False, # Whether the entity type should be considered inactive.
+        },
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+              "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                  "format": "A String", # The format the summary should be in.
+                  "length": "A String", # How long the summary should be.
+                },
+              },
+              "inactive": True or False, # Whether the property should be considered as "inactive".
+            },
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+        "displayName": "A String", # User defined name for the type.
+        "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+          "inactive": True or False, # Whether the entity type should be considered inactive.
+        },
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+              "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                  "format": "A String", # The format the summary should be in.
+                  "length": "A String", # How long the summary should be.
+                },
+              },
+              "inactive": True or False, # Whether the property should be considered as "inactive".
+            },
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) + 
Deletes a schema version.
+
+Args:
+  name: string, Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ generate(parent, body=None, x__xgafv=None) + 
Generates a schema version.
+
+Args:
+  parent: string, Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GenerateSchemaVersion.
+  "baseSchemaVersion": "A String", # The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "gcsDocuments": { # Specifies a set of documents on Cloud Storage. # The set of documents placed on Cloud Storage.
+    "documents": [ # The list of documents.
+      { # Specifies a document stored on Cloud Storage.
+        "gcsUri": "A String", # The Cloud Storage object uri.
+        "mimeType": "A String", # An IANA MIME type (RFC6838) of the content.
+      },
+    ],
+  },
+  "gcsPrefix": { # Specifies all documents on Cloud Storage with a common prefix. # The common prefix of documents placed on Cloud Storage.
+    "gcsUriPrefix": "A String", # The URI prefix.
+  },
+  "generateSchemaVersionParams": { # The parameters for the schema generation. # Optional. User specified parameters for the schema generation.
+    "history": { # The history of schema generation iterations. # Optional. Previous prompt-answers in a chronological order.
+      "iterations": [ # Required. Previous prompt-answers in a chronological order.
+        { # A single iteration of the schema generation.
+          "adjustedSchema": { # SchemaVersion is a version of the Schema which is created in SchemaGroup. # Optional. The previous schema version adjusted by the model.
+            "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+            "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+            "labels": { # Optional. The GCP labels for the SchemaVersion.
+              "a_key": "A String",
+            },
+            "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+            "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+              "description": "A String", # Description of the schema.
+              "displayName": "A String", # Display name to show to users.
+              "entityTypes": [ # Entity types of the schema.
+                { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+                  "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+                    "A String",
+                  ],
+                  "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+                  "displayName": "A String", # User defined name for the type.
+                  "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+                    "inactive": True or False, # Whether the entity type should be considered inactive.
+                  },
+                  "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+                    "values": [ # The individual values that this enum values type can include.
+                      "A String",
+                    ],
+                  },
+                  "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+                  "properties": [ # Description the nested structure, or composition of an entity.
+                    { # Defines properties that can be part of the entity type.
+                      "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+                      "displayName": "A String", # User defined name for the property.
+                      "method": "A String", # Specifies how the entity's value is obtained.
+                      "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+                      "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+                      "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+                        "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                          "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                            "format": "A String", # The format the summary should be in.
+                            "length": "A String", # How long the summary should be.
+                          },
+                        },
+                        "inactive": True or False, # Whether the property should be considered as "inactive".
+                      },
+                      "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+                    },
+                  ],
+                },
+              ],
+              "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+                "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+                "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+                "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+                "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+              },
+            },
+          },
+          "generatedSchema": { # SchemaVersion is a version of the Schema which is created in SchemaGroup. # Required. The schema version generated by the model.
+            "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+            "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+            "labels": { # Optional. The GCP labels for the SchemaVersion.
+              "a_key": "A String",
+            },
+            "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+            "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+              "description": "A String", # Description of the schema.
+              "displayName": "A String", # Display name to show to users.
+              "entityTypes": [ # Entity types of the schema.
+                { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+                  "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+                    "A String",
+                  ],
+                  "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+                  "displayName": "A String", # User defined name for the type.
+                  "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+                    "inactive": True or False, # Whether the entity type should be considered inactive.
+                  },
+                  "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+                    "values": [ # The individual values that this enum values type can include.
+                      "A String",
+                    ],
+                  },
+                  "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+                  "properties": [ # Description the nested structure, or composition of an entity.
+                    { # Defines properties that can be part of the entity type.
+                      "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+                      "displayName": "A String", # User defined name for the property.
+                      "method": "A String", # Specifies how the entity's value is obtained.
+                      "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+                      "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+                      "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+                        "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                          "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                            "format": "A String", # The format the summary should be in.
+                            "length": "A String", # How long the summary should be.
+                          },
+                        },
+                        "inactive": True or False, # Whether the property should be considered as "inactive".
+                      },
+                      "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+                    },
+                  ],
+                },
+              ],
+              "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+                "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+                "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+                "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+                "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+              },
+            },
+          },
+          "prompt": "A String", # Optional. The prompt used for the iteration.
+        },
+      ],
+    },
+    "prompt": "A String", # Optional. The prompt used for the schema generation.
+  },
+  "inlineDocuments": { # A set of inline documents. # The set of documents specified inline.
+    "documents": [ # The list of documents.
+      { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.
+        "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
+          { # Represents a blob asset. It's used to store the content of the inline blob in this document, e.g. image bytes, such that it can be referenced by other fields in the document via asset id.
+            "assetId": "A String", # Optional. The id of the blob asset.
+            "content": "A String", # Optional. The content of the blob asset, e.g. image bytes.
+            "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
+          },
+        ],
+        "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config.
+          "chunks": [ # List of chunks.
+            { # Represents a chunk.
+              "chunkFields": [ # Chunk fields inside this chunk.
+                { # The chunk field in the chunk. A chunk field could be one of the various types (e.g. image, table) supported.
+                  "imageChunkField": { # The image chunk field in the chunk. # The image chunk field in the chunk.
+                    "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field.
+                      "description": "A String", # The description of the content with this annotation.
+                    },
+                    "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.
+                    "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,
+                    "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image.
+                  },
+                  "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk.
+                    "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field.
+                      "description": "A String", # The description of the content with this annotation.
+                    },
+                  },
+                },
+              ],
+              "chunkId": "A String", # ID of the chunk.
+              "content": "A String", # Text content of the chunk.
+              "pageFooters": [ # Page footers associated with the chunk.
+                { # Represents the page footer associated with the chunk.
+                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer.
+                    "pageEnd": 42, # Page where chunk ends in the document.
+                    "pageStart": 42, # Page where chunk starts in the document.
+                  },
+                  "text": "A String", # Footer in text format.
+                },
+              ],
+              "pageHeaders": [ # Page headers associated with the chunk.
+                { # Represents the page header associated with the chunk.
+                  "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header.
+                    "pageEnd": 42, # Page where chunk ends in the document.
+                    "pageStart": 42, # Page where chunk starts in the document.
+                  },
+                  "text": "A String", # Header in text format.
+                },
+              ],
+              "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk.
+                "pageEnd": 42, # Page where chunk ends in the document.
+                "pageStart": 42, # Page where chunk starts in the document.
+              },
+              "sourceBlockIds": [ # Unused.
+                "A String",
+              ],
+            },
+          ],
+        },
+        "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
+        "docid": "A String", # Optional. An internal identifier for document. Should be loggable (no PII).
+        "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document.
+          "blocks": [ # List of blocks in the document.
+            { # Represents a block. A block could be one of the various types (text, table, list) supported.
+              "blockId": "A String", # ID of the block.
+              "boundingBox": { # A bounding polygon for the detected image annotation. # Identifies the bounding box for the block.
+                "normalizedVertices": [ # The bounding polygon normalized vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                    "x": 3.14, # X coordinate.
+                    "y": 3.14, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+                "vertices": [ # The bounding polygon vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                    "x": 42, # X coordinate.
+                    "y": 42, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+              },
+              "imageBlock": { # Represents an image type block. # Block consisting of image content.
+                "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block.
+                  "description": "A String", # The description of the content with this annotation.
+                },
+                "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.
+                "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,
+                "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image.
+                "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image.
+                "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml).
+              },
+              "listBlock": { # Represents a list type block. # Block consisting of list content/structure.
+                "listEntries": [ # List entries that constitute a list block.
+                  { # Represents an entry in the list.
+                    "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
+                      # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
+                    ],
+                  },
+                ],
+                "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`.
+              },
+              "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block.
+                "pageEnd": 42, # Page where block ends in the document.
+                "pageStart": 42, # Page where block starts in the document.
+              },
+              "tableBlock": { # Represents a table type block. # Block consisting of table content/structure.
+                "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table block.
+                  "description": "A String", # The description of the content with this annotation.
+                },
+                "bodyRows": [ # Body rows containing main table content.
+                  { # Represents a row in a table.
+                    "cells": [ # A table row is a list of table cells.
+                      { # Represents a cell in a table row.
+                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
+                          # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
+                        ],
+                        "colSpan": 42, # How many columns this cell spans.
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+                "caption": "A String", # Table caption/title.
+                "headerRows": [ # Header rows at the top of the table.
+                  { # Represents a row in a table.
+                    "cells": [ # A table row is a list of table cells.
+                      { # Represents a cell in a table row.
+                        "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.
+                          # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
+                        ],
+                        "colSpan": 42, # How many columns this cell spans.
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+              },
+              "textBlock": { # Represents a text type block. # Block consisting of text content.
+                "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+                  "description": "A String", # The description of the content with this annotation.
+                },
+                "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
+                  # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
+                ],
+                "text": "A String", # Text content stored in the block.
+                "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.
+              },
+            },
+          ],
+        },
+        "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.
+          { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
+            "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
+            "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
+            "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
+            "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
+            "method": "A String", # Optional. Specifies how the entity's value is obtained.
+            "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
+              "addressValue": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
+                "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+                  "A String",
+                ],
+                "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+                "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+                "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+                "organization": "A String", # Optional. The name of the organization at the address.
+                "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+                "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+                  "A String",
+                ],
+                "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+                "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+                "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+                "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+              },
+              "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
+              "dateValue": { # 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 # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
+                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+              },
+              "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
+                "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+                "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+                "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+                "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+                "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+                "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+                  "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+                  "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+                },
+                "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+                "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+              },
+              "floatValue": 3.14, # Float value.
+              "integerValue": 42, # Integer value.
+              "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
+                "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+                "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+                "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+              },
+              "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document.
+              "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
+            },
+            "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
+              "pageRefs": [ # One or more references to visual page elements
+                { # Represents a weak reference to a page element within a document.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
+                  "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
+                  "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
+                  "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
+                },
+              ],
+            },
+            "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
+              # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity
+            ],
+            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
+              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              "parents": [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  "id": 42, # The id of the parent provenance.
+                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  "revision": 42, # The index of the index into current revision's parent_ids list.
+                },
+              ],
+              "revision": 42, # The index of the revision that produced this element.
+              "type": "A String", # The type of provenance operation.
+            },
+            "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
+            "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
+              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+              "textSegments": [ # The text segments from the Document.text.
+                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                },
+              ],
+            },
+            "type": "A String", # Required. Entity type from a schema e.g. `Address`.
+          },
+        ],
+        "entitiesRevisionId": "A String", # The entity revision id that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.
+        "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing.
+          { # Entity revision.
+            "entities": [ # The entities in this revision.
+              { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.
+                "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`.
+                "id": "A String", # Optional. Canonical id. This will be a unique value in the entity list for this document.
+                "mentionId": "A String", # Optional. Deprecated. Use `id` field instead.
+                "mentionText": "A String", # Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
+                "method": "A String", # Optional. Specifies how the entity's value is obtained.
+                "normalizedValue": { # Parsed and normalized entity value. # Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types.
+                  "addressValue": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto
+                    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+                      "A String",
+                    ],
+                    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+                    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+                    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+                    "organization": "A String", # Optional. The name of the organization at the address.
+                    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+                    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+                      "A String",
+                    ],
+                    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+                    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+                    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+                    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+                  },
+                  "booleanValue": True or False, # Boolean value. Can be used for entities with binary values, or for checkboxes.
+                  "dateValue": { # 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 # Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto
+                    "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                    "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                    "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+                  },
+                  "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto
+                    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+                    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+                    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+                    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+                    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+                    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+                      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+                      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+                    },
+                    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+                    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+                  },
+                  "floatValue": 3.14, # Float value.
+                  "integerValue": 42, # Integer value.
+                  "moneyValue": { # Represents an amount of money with its currency type. # Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto
+                    "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+                    "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+                    "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+                  },
+                  "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document.
+                  "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format.
+                },
+                "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found.
+                  "pageRefs": [ # One or more references to visual page elements
+                    { # Represents a weak reference to a page element within a document.
+                      "boundingPoly": { # A bounding polygon for the detected image annotation. # Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to.
+                        "normalizedVertices": [ # The bounding polygon normalized vertices.
+                          { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                            "x": 3.14, # X coordinate.
+                            "y": 3.14, # Y coordinate (starts from the top of the image).
+                          },
+                        ],
+                        "vertices": [ # The bounding polygon vertices.
+                          { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                            "x": 42, # X coordinate.
+                            "y": 42, # Y coordinate (starts from the top of the image).
+                          },
+                        ],
+                      },
+                      "confidence": 3.14, # Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.
+                      "layoutId": "A String", # Optional. Deprecated. Use PageRef.bounding_poly instead.
+                      "layoutType": "A String", # Optional. The type of the layout element that is being referenced if any.
+                      "page": "A String", # Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.
+                    },
+                  ],
+                },
+                "properties": [ # Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.
+                  # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity
+                ],
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+                "redacted": True or False, # Optional. Whether the entity will be redacted for de-identification purposes.
+                "textAnchor": { # Text reference indexing into the Document.text. # Optional. Provenance of the entity. Text anchor indexing into the Document.text.
+                  "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                  "textSegments": [ # The text segments from the Document.text.
+                    { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                      "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                      "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                    },
+                  ],
+                },
+                "type": "A String", # Required. Entity type from a schema e.g. `Address`.
+              },
+            ],
+            "entityValidationOutput": { # The output of the validation given the document and the validation rules. # The entity validation output for this revision.
+              "passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid.
+              "validationResults": [ # The result of each validation rule.
+                { # Validation result for a single validation rule.
+                  "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`
+                  "ruleDescription": "A String", # The description of the validation rule.
+                  "ruleName": "A String", # The display name of the validation rule.
+                  "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule.
+                  "validationResultType": "A String", # The result of the validation rule.
+                },
+              ],
+            },
+            "revisionId": "A String", # The revision id.
+          },
+        ],
+        "entityRelations": [ # Placeholder. Relationship among Document.entities.
+          { # Relationship between Entities.
+            "objectId": "A String", # Object entity id.
+            "relation": "A String", # Relationship description.
+            "subjectId": "A String", # Subject entity id.
+          },
+        ],
+        "entityValidationOutput": { # The output of the validation given the document and the validation rules. # The entity validation output for the document. This is the validation output for `document.entities` field.
+          "passAllRules": True or False, # The overall result of the validation, true if all applicable rules are valid.
+          "validationResults": [ # The result of each validation rule.
+            { # Validation result for a single validation rule.
+              "rule": "A String", # Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`
+              "ruleDescription": "A String", # The description of the validation rule.
+              "ruleName": "A String", # The display name of the validation rule.
+              "validationDetails": "A String", # The detailed information of the running the validation process using the entity from the document based on the validation rule.
+              "validationResultType": "A String", # The result of the validation rule.
+            },
+          ],
+        },
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Any error that occurred while processing this document.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "mimeType": "A String", # An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
+        "pages": [ # Visual page layout for the Document.
+          { # A page in a Document.
+            "blocks": [ # A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
+              { # A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Block.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "detectedBarcodes": [ # A list of detected barcodes.
+              { # A detected barcode.
+                "barcode": { # Encodes the detailed information of a barcode. # Detailed barcode information of the DetectedBarcode.
+                  "format": "A String", # Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.
+                  "rawValue": "A String", # Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.
+                  "valueFormat": "A String", # Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.
+                },
+                "layout": { # Visual element describing a layout unit on a page. # Layout for DetectedBarcode.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+              },
+            ],
+            "detectedLanguages": [ # A list of detected languages together with confidence.
+              { # Detected language for a structural component.
+                "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+              },
+            ],
+            "dimension": { # Dimension for the page. # Physical dimension of the page.
+              "height": 3.14, # Page height.
+              "unit": "A String", # Dimension unit.
+              "width": 3.14, # Page width.
+            },
+            "formFields": [ # A list of visually detected form fields on the page.
+              { # A form field detected on the page.
+                "correctedKeyText": "A String", # Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.
+                "correctedValueText": "A String", # Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.
+                "fieldName": { # Visual element describing a layout unit on a page. # Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "fieldValue": { # Visual element describing a layout unit on a page. # Layout for the FormField value.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "nameDetectedLanguages": [ # A list of detected languages for name together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+                "valueDetectedLanguages": [ # A list of detected languages for value together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "valueType": "A String", # If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`
+              },
+            ],
+            "image": { # Rendered image contents for this page. # Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned.
+              "content": "A String", # Raw byte content of the image.
+              "height": 42, # Height of the image in pixels.
+              "mimeType": "A String", # Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.
+              "width": 42, # Width of the image in pixels.
+            },
+            "imageQualityScores": { # Image quality scores for the page image. # Image quality scores.
+              "detectedDefects": [ # A list of detected defects.
+                { # Image Quality Defects
+                  "confidence": 3.14, # Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.
+                  "type": "A String", # Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`
+                },
+              ],
+              "qualityScore": 3.14, # The overall quality score. Range `[0, 1]` where `1` is perfect quality.
+            },
+            "layout": { # Visual element describing a layout unit on a page. # Layout for the page.
+              "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                "normalizedVertices": [ # The bounding polygon normalized vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                    "x": 3.14, # X coordinate.
+                    "y": 3.14, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+                "vertices": [ # The bounding polygon vertices.
+                  { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                    "x": 42, # X coordinate.
+                    "y": 42, # Y coordinate (starts from the top of the image).
+                  },
+                ],
+              },
+              "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+              "orientation": "A String", # Detected orientation for the Layout.
+              "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                "textSegments": [ # The text segments from the Document.text.
+                  { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                    "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                    "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                  },
+                ],
+              },
+            },
+            "lines": [ # A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.
+              { # A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Line.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "pageNumber": 42, # 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.
+            "paragraphs": [ # A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.
+              { # A collection of lines that a human would perceive as a paragraph.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Paragraph.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page.
+              "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+              "parents": [ # References to the original elements that are replaced.
+                { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                  "id": 42, # The id of the parent provenance.
+                  "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                  "revision": 42, # The index of the index into current revision's parent_ids list.
+                },
+              ],
+              "revision": 42, # The index of the revision that produced this element.
+              "type": "A String", # The type of provenance operation.
+            },
+            "symbols": [ # A list of visually detected symbols on the page.
+              { # A detected symbol.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Symbol.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+              },
+            ],
+            "tables": [ # A list of visually detected tables on the page.
+              { # A table representation similar to HTML table structure.
+                "bodyRows": [ # Body rows of the table.
+                  { # A row of table cells.
+                    "cells": [ # Cells that make up this row.
+                      { # A cell representation inside the table.
+                        "colSpan": 42, # How many columns this cell spans.
+                        "detectedLanguages": [ # A list of detected languages together with confidence.
+                          { # Detected language for a structural component.
+                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                          },
+                        ],
+                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
+                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                            "normalizedVertices": [ # The bounding polygon normalized vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                                "x": 3.14, # X coordinate.
+                                "y": 3.14, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                            "vertices": [ # The bounding polygon vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                                "x": 42, # X coordinate.
+                                "y": 42, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                          },
+                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                          "orientation": "A String", # Detected orientation for the Layout.
+                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                            "textSegments": [ # The text segments from the Document.text.
+                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                              },
+                            ],
+                          },
+                        },
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "headerRows": [ # Header rows of the table.
+                  { # A row of table cells.
+                    "cells": [ # Cells that make up this row.
+                      { # A cell representation inside the table.
+                        "colSpan": 42, # How many columns this cell spans.
+                        "detectedLanguages": [ # A list of detected languages together with confidence.
+                          { # Detected language for a structural component.
+                            "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                            "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                          },
+                        ],
+                        "layout": { # Visual element describing a layout unit on a page. # Layout for TableCell.
+                          "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                            "normalizedVertices": [ # The bounding polygon normalized vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                                "x": 3.14, # X coordinate.
+                                "y": 3.14, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                            "vertices": [ # The bounding polygon vertices.
+                              { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                                "x": 42, # X coordinate.
+                                "y": 42, # Y coordinate (starts from the top of the image).
+                              },
+                            ],
+                          },
+                          "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                          "orientation": "A String", # Detected orientation for the Layout.
+                          "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                            "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                            "textSegments": [ # The text segments from the Document.text.
+                              { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                                "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                                "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                              },
+                            ],
+                          },
+                        },
+                        "rowSpan": 42, # How many rows this cell spans.
+                      },
+                    ],
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Table.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+              },
+            ],
+            "tokens": [ # A list of visually detected tokens on the page.
+              { # A detected token.
+                "detectedBreak": { # Detected break at the end of a Token. # Detected break at the end of a Token.
+                  "type": "A String", # Detected break type.
+                },
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for Token.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation.
+                  "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                  "parents": [ # References to the original elements that are replaced.
+                    { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                      "id": 42, # The id of the parent provenance.
+                      "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                      "revision": 42, # The index of the index into current revision's parent_ids list.
+                    },
+                  ],
+                  "revision": 42, # The index of the revision that produced this element.
+                  "type": "A String", # The type of provenance operation.
+                },
+                "styleInfo": { # Font and other text style attributes. # Text style attributes.
+                  "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the background.
+                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                  },
+                  "bold": True or False, # Whether the text is bold (equivalent to font_weight is at least `700`).
+                  "fontSize": 42, # Font size in points (`1` point is `¹⁄₇₂` inches).
+                  "fontType": "A String", # Name or style of the font.
+                  "fontWeight": 42, # TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.
+                  "handwritten": True or False, # Whether the text is handwritten.
+                  "italic": True or False, # Whether the text is italic.
+                  "letterSpacing": 3.14, # Letter spacing in points.
+                  "pixelFontSize": 3.14, # Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.
+                  "smallcaps": True or False, # Whether the text is in small caps. This feature is not supported yet.
+                  "strikeout": True or False, # Whether the text is strikethrough. This feature is not supported yet.
+                  "subscript": True or False, # Whether the text is a subscript. This feature is not supported yet.
+                  "superscript": True or False, # Whether the text is a superscript. This feature is not supported yet.
+                  "textColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Color of the text.
+                    "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+                    "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+                    "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+                    "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+                  },
+                  "underlined": True or False, # Whether the text is underlined.
+                },
+              },
+            ],
+            "transforms": [ # Transformation matrices that were applied to the original document image to produce Page.image.
+              { # Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.
+                "cols": 42, # Number of columns in the matrix.
+                "data": "A String", # The matrix data.
+                "rows": 42, # Number of rows in the matrix.
+                "type": 42, # This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html
+              },
+            ],
+            "visualElements": [ # A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.
+              { # Detected non-text visual elements e.g. checkbox, signature etc. on the page.
+                "detectedLanguages": [ # A list of detected languages together with confidence.
+                  { # Detected language for a structural component.
+                    "confidence": 3.14, # Confidence of detected language. Range `[0, 1]`.
+                    "languageCode": "A String", # The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.
+                  },
+                ],
+                "layout": { # Visual element describing a layout unit on a page. # Layout for VisualElement.
+                  "boundingPoly": { # A bounding polygon for the detected image annotation. # The bounding polygon for the Layout.
+                    "normalizedVertices": [ # The bounding polygon normalized vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.
+                        "x": 3.14, # X coordinate.
+                        "y": 3.14, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                    "vertices": [ # The bounding polygon vertices.
+                      { # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.
+                        "x": 42, # X coordinate.
+                        "y": 42, # Y coordinate (starts from the top of the image).
+                      },
+                    ],
+                  },
+                  "confidence": 3.14, # Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.
+                  "orientation": "A String", # Detected orientation for the Layout.
+                  "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+                    "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+                    "textSegments": [ # The text segments from the Document.text.
+                      { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                        "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                        "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                      },
+                    ],
+                  },
+                },
+                "type": "A String", # Type of the VisualElement.
+              },
+            ],
+          },
+        ],
+        "revisions": [ # Placeholder. Revision history of this document.
+          { # Contains past or forward revisions of this document.
+            "agent": "A String", # If the change was made by a person specify the name or id of that person.
+            "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create.
+            "humanReview": { # Human Review information of the document. # Human Review information of this revision.
+              "state": "A String", # Human review state. e.g. `requested`, `succeeded`, `rejected`.
+              "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.
+            },
+            "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document.
+            "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.
+              42,
+            ],
+            "parentIds": [ # The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.
+              "A String",
+            ],
+            "processor": "A String", # If the annotation was made by processor identify the processor by its resource name.
+          },
+        ],
+        "shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+          "shardCount": "A String", # Total number of shards.
+          "shardIndex": "A String", # The 0-based index of this shard.
+          "textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
+        },
+        "text": "A String", # Optional. UTF-8 encoded text in reading order from the document.
+        "textChanges": [ # Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.
+          { # This message is used for text changes aka. OCR corrections.
+            "changedText": "A String", # The text that replaces the text identified in the `text_anchor`.
+            "provenance": [ # The history of this annotation.
+              { # Structure to identify provenance relationships between annotations in different revisions.
+                "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision.
+                "parents": [ # References to the original elements that are replaced.
+                  { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.
+                    "id": 42, # The id of the parent provenance.
+                    "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.
+                    "revision": 42, # The index of the index into current revision's parent_ids list.
+                  },
+                ],
+                "revision": 42, # The index of the revision that produced this element.
+                "type": "A String", # The type of provenance operation.
+              },
+            ],
+            "textAnchor": { # Text reference indexing into the Document.text. # Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index.
+              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+              "textSegments": [ # The text segments from the Document.text.
+                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                },
+              ],
+            },
+          },
+        ],
+        "textStyles": [ # Styles for the Document.text.
+          { # Annotation for common text style attributes. This adheres to CSS conventions as much as possible.
+            "backgroundColor": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text background color.
+              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+            },
+            "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # Text color.
+              "alpha": 3.14, # The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
+              "blue": 3.14, # The amount of blue in the color as a value in the interval [0, 1].
+              "green": 3.14, # The amount of green in the color as a value in the interval [0, 1].
+              "red": 3.14, # The amount of red in the color as a value in the interval [0, 1].
+            },
+            "fontFamily": "A String", # Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp
+            "fontSize": { # Font size with unit. # Font size.
+              "size": 3.14, # Font size for the text.
+              "unit": "A String", # Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).
+            },
+            "fontWeight": "A String", # [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.
+            "textAnchor": { # Text reference indexing into the Document.text. # Text anchor indexing into the Document.text.
+              "content": "A String", # Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.
+              "textSegments": [ # The text segments from the Document.text.
+                { # A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset
+                  "endIndex": "A String", # TextSegment half open end UTF-8 char index in the Document.text.
+                  "startIndex": "A String", # TextSegment start UTF-8 char index in the Document.text.
+                },
+              ],
+            },
+            "textDecoration": "A String", # [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard.
+            "textStyle": "A String", # [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.
+          },
+        ],
+        "uri": "A String", # Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).
+      },
+    ],
+  },
+  "rawDocuments": { # Specifies a set of raw documents. # The set of raw documents.
+    "documents": [ # Specifies raw document content and mime type.
+      { # Payload message of raw document content (bytes).
+        "content": "A String", # Inline document content.
+        "displayName": "A String", # The display name of the document, it supports all Unicode characters except the following: `*`, `?`, `[`, `]`, `%`, `{`, `}`,`'`, `\"`, `,` `~`, `=` and `:` are reserved. If not specified, a default ID is generated.
+        "mimeType": "A String", # An IANA MIME type (RFC6838) indicating the nature and format of the content.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for GenerateSchemaVersion.
+  "schemaVersion": { # SchemaVersion is a version of the Schema which is created in SchemaGroup. # The schema version generated by the model.
+    "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+    "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+    "labels": { # Optional. The GCP labels for the SchemaVersion.
+      "a_key": "A String",
+    },
+    "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+    "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+      "description": "A String", # Description of the schema.
+      "displayName": "A String", # Display name to show to users.
+      "entityTypes": [ # Entity types of the schema.
+        { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+          "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+            "A String",
+          ],
+          "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+          "displayName": "A String", # User defined name for the type.
+          "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+            "inactive": True or False, # Whether the entity type should be considered inactive.
+          },
+          "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+            "values": [ # The individual values that this enum values type can include.
+              "A String",
+            ],
+          },
+          "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+          "properties": [ # Description the nested structure, or composition of an entity.
+            { # Defines properties that can be part of the entity type.
+              "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+              "displayName": "A String", # User defined name for the property.
+              "method": "A String", # Specifies how the entity's value is obtained.
+              "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+              "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+              "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+                "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                  "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                    "format": "A String", # The format the summary should be in.
+                    "length": "A String", # How long the summary should be.
+                  },
+                },
+                "inactive": True or False, # Whether the property should be considered as "inactive".
+              },
+              "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+            },
+          ],
+        },
+      ],
+      "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+        "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+        "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+        "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+        "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+      },
+    },
+  },
+}
+
+ +
+ get(name, x__xgafv=None) + 
Gets a schema version.
+
+Args:
+  name: string, Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+        "displayName": "A String", # User defined name for the type.
+        "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+          "inactive": True or False, # Whether the entity type should be considered inactive.
+        },
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+              "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                  "format": "A String", # The format the summary should be in.
+                  "length": "A String", # How long the summary should be.
+                },
+              },
+              "inactive": True or False, # Whether the property should be considered as "inactive".
+            },
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists SchemaVersions.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}/schemas/{schema}` (required)
+  pageSize: integer, Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.
+  pageToken: string, Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListSchemaVersions.
+  "nextPageToken": "A String", # Points to the next SchemaVersion, otherwise empty.
+  "schemaVersions": [ # The list of SchemaVersions.
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+      "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+      "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+      "labels": { # Optional. The GCP labels for the SchemaVersion.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+      "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+        "description": "A String", # Description of the schema.
+        "displayName": "A String", # Display name to show to users.
+        "entityTypes": [ # Entity types of the schema.
+          { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+            "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+              "A String",
+            ],
+            "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+            "displayName": "A String", # User defined name for the type.
+            "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+              "inactive": True or False, # Whether the entity type should be considered inactive.
+            },
+            "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+              "values": [ # The individual values that this enum values type can include.
+                "A String",
+              ],
+            },
+            "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+            "properties": [ # Description the nested structure, or composition of an entity.
+              { # Defines properties that can be part of the entity type.
+                "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+                "displayName": "A String", # User defined name for the property.
+                "method": "A String", # Specifies how the entity's value is obtained.
+                "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+                "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+                "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+                  "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                    "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                      "format": "A String", # The format the summary should be in.
+                      "length": "A String", # How long the summary should be.
+                    },
+                  },
+                  "inactive": True or False, # Whether the property should be considered as "inactive".
+                },
+                "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+              },
+            ],
+          },
+        ],
+        "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+          "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+          "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+          "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+          "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+        },
+      },
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) + 
Updates a schema version. Editable fields are: - `display_name` - `labels`
+
+Args:
+  name: string, Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+        "displayName": "A String", # User defined name for the type.
+        "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+          "inactive": True or False, # Whether the entity type should be considered inactive.
+        },
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+              "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                  "format": "A String", # The format the summary should be in.
+                  "length": "A String", # How long the summary should be.
+                },
+              },
+              "inactive": True or False, # Whether the property should be considered as "inactive".
+            },
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+  updateMask: string, Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # SchemaVersion is a version of the Schema which is created in SchemaGroup.
+  "createTime": "A String", # Output only. The time when the SchemaVersion was created.
+  "displayName": "A String", # Optional. The user-defined name of the SchemaVersion.
+  "labels": { # Optional. The GCP labels for the SchemaVersion.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`
+  "schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion.
+    "description": "A String", # Description of the schema.
+    "displayName": "A String", # Display name to show to users.
+    "entityTypes": [ # Entity types of the schema.
+      { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.
+        "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set.
+          "A String",
+        ],
+        "description": "A String", # The description of the entity type. Could be used to provide more information about the entity type for model calls.
+        "displayName": "A String", # User defined name for the type.
+        "entityTypeMetadata": { # Metadata about an entity type. # Metadata for the entity type.
+          "inactive": True or False, # Whether the entity type should be considered inactive.
+        },
+        "enumValues": { # Defines the a list of enum values. # If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file.
+          "values": [ # The individual values that this enum values type can include.
+            "A String",
+          ],
+        },
+        "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.
+        "properties": [ # Description the nested structure, or composition of an entity.
+          { # Defines properties that can be part of the entity type.
+            "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls.
+            "displayName": "A String", # User defined name for the property.
+            "method": "A String", # Specifies how the entity's value is obtained.
+            "name": "A String", # The name of the property. Follows the same guidelines as the EntityType name.
+            "occurrenceType": "A String", # Occurrence type limits the number of instances an entity type appears in the document.
+            "propertyMetadata": { # Metadata about a property. # Any additional metadata about the property can be added here.
+              "fieldExtractionMetadata": { # Metadata for how this field value is extracted. # Field extraction metadata on the property.
+                "summaryOptions": { # Metadata for document summarization. # Summary options config.
+                  "format": "A String", # The format the summary should be in.
+                  "length": "A String", # How long the summary should be.
+                },
+              },
+              "inactive": True or False, # Whether the property should be considered as "inactive".
+            },
+            "valueType": "A String", # A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.
+          },
+        ],
+      },
+    ],
+    "metadata": { # Metadata for global schema behavior. # Metadata of the schema.
+      "documentAllowMultipleLabels": True or False, # If true, on a given page, there can be multiple `document` annotations covering it.
+      "documentSplitter": True or False, # If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
+      "prefixedNamingOnProperties": True or False, # If set, all the nested entities must be prefixed with the parents.
+      "skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index f3baa14782..4ff7e1885f 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1018,6 +1018,345 @@ } } } +}, +"schemas": { +"methods": { +"create": { +"description": "Creates a schema.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas", +"httpMethod": "POST", +"id": "documentai.projects.locations.schemas.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/schemas", +"request": { +"$ref": "GoogleCloudDocumentaiV1NextSchema" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1NextSchema" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a schema.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", +"httpMethod": "DELETE", +"id": "documentai.projects.locations.schemas.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a schema.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDocumentaiV1NextSchema" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Schemas.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/schemas", +"response": { +"$ref": "GoogleCloudDocumentaiV1ListSchemasResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a schema. Editable fields are: - `display_name` - `labels`", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", +"httpMethod": "PATCH", +"id": "documentai.projects.locations.schemas.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDocumentaiV1NextSchema" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1NextSchema" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"schemaVersions": { +"methods": { +"create": { +"description": "Creates a schema version.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", +"httpMethod": "POST", +"id": "documentai.projects.locations.schemas.schemaVersions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/schemaVersions", +"request": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a schema version.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", +"httpMethod": "DELETE", +"id": "documentai.projects.locations.schemas.schemaVersions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generate": { +"description": "Generates a schema version.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate", +"httpMethod": "POST", +"id": "documentai.projects.locations.schemas.schemaVersions.generate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/schemaVersions:generate", +"request": { +"$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a schema version.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.schemaVersions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists SchemaVersions.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.schemaVersions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/schemaVersions", +"response": { +"$ref": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a schema version. Editable fields are: - `display_name` - `labels`", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", +"httpMethod": "PATCH", +"id": "documentai.projects.locations.schemas.schemaVersions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } }, @@ -1053,7 +1392,7 @@ } } }, -"revision": "20251013", +"revision": "20251020", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -1678,11 +2017,174 @@ }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { -"description": "The long-running operation metadata for the EnableProcessor method.", -"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", +"GoogleCloudDocumentaiUiv1beta3DocumentSchema": { +"description": "The schema defines the output of the processed document by a processor.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", "properties": { -"commonMetadata": { +"description": { +"description": "Description of the schema.", +"type": "string" +}, +"displayName": { +"description": "Display name to show to users.", +"type": "string" +}, +"entityTypes": { +"description": "Entity types of the schema.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType" +}, +"type": "array" +}, +"metadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", +"description": "Metadata of the schema." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": { +"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType", +"properties": { +"baseTypes": { +"description": "The entity type that this type is derived from. For now, one and only one should be set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", +"type": "string" +}, +"displayName": { +"description": "User defined name for the type.", +"type": "string" +}, +"entityTypeMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", +"description": "Metadata for the entity type." +}, +"enumValues": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", +"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." +}, +"name": { +"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", +"type": "string" +}, +"properties": { +"description": "Description the nested structure, or composition of an entity.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": { +"description": "Defines the a list of enum values.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", +"properties": { +"values": { +"description": "The individual values that this enum values type can include.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": { +"description": "Defines properties that can be part of the entity type.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty", +"properties": { +"description": { +"description": "The description of the property. Could be used to provide more information about the property for model calls.", +"type": "string" +}, +"displayName": { +"description": "User defined name for the property.", +"type": "string" +}, +"method": { +"description": "Specifies how the entity's value is obtained.", +"enum": [ +"METHOD_UNSPECIFIED", +"EXTRACT", +"DERIVE" +], +"enumDescriptions": [ +"Unspecified method. It defaults to `EXTRACT`.", +"The entity's value is directly extracted as-is from the document text.", +"The entity's value is derived through inference and is not necessarily an exact text extraction from the document." +], +"type": "string" +}, +"name": { +"description": "The name of the property. Follows the same guidelines as the EntityType name.", +"type": "string" +}, +"occurrenceType": { +"description": "Occurrence type limits the number of instances an entity type appears in the document.", +"enum": [ +"OCCURRENCE_TYPE_UNSPECIFIED", +"OPTIONAL_ONCE", +"OPTIONAL_MULTIPLE", +"REQUIRED_ONCE", +"REQUIRED_MULTIPLE" +], +"enumDescriptions": [ +"Unspecified occurrence type.", +"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", +"The entity type will appear zero or multiple times.", +"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", +"The entity type will appear once or more times." +], +"type": "string" +}, +"propertyMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", +"description": "Any additional metadata about the property can be added here." +}, +"valueType": { +"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": { +"description": "Metadata for global schema behavior.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", +"properties": { +"documentAllowMultipleLabels": { +"description": "If true, on a given page, there can be multiple `document` annotations covering it.", +"type": "boolean" +}, +"documentSplitter": { +"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", +"type": "boolean" +}, +"prefixedNamingOnProperties": { +"description": "If set, all the nested entities must be prefixed with the parents.", +"type": "boolean" +}, +"skipNamingValidation": { +"description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { +"description": "The long-running operation metadata for the EnableProcessor method.", +"id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", +"properties": { +"commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", "description": "The basic metadata of the long-running operation." } @@ -1695,6 +2197,37 @@ "properties": {}, "type": "object" }, +"GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": { +"description": "Metadata about an entity type.", +"id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", +"properties": { +"fieldTierMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", +"description": "Field tier metadata on the property" +}, +"humanReviewLabelingMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", +"description": "Human review labeling config on the entity." +}, +"humanReviewMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", +"description": "Human review config on the entity." +}, +"inactive": { +"description": "Whether the entity type should be considered inactive.", +"type": "boolean" +}, +"schemaEditabilityMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", +"description": "Schema editability metadata on the entity." +}, +"schemaInferenceMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", +"description": "Schema inference metadata on the entity." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": { "description": "Metadata of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata", @@ -1717,6 +2250,91 @@ }, "type": "object" }, +"GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": { +"description": "Evaluation metrics, either in aggregate or about a specific entity.", +"id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", +"properties": { +"f1Score": { +"description": "The calculated f1 score.", +"format": "float", +"type": "number" +}, +"falseNegativesCount": { +"description": "The amount of false negatives.", +"format": "int32", +"type": "integer" +}, +"falsePositivesCount": { +"description": "The amount of false positives.", +"format": "int32", +"type": "integer" +}, +"groundTruthDocumentCount": { +"description": "The amount of documents with a ground truth occurrence.", +"format": "int32", +"type": "integer" +}, +"groundTruthOccurrencesCount": { +"description": "The amount of occurrences in ground truth documents.", +"format": "int32", +"type": "integer" +}, +"precision": { +"description": "The calculated precision.", +"format": "float", +"type": "number" +}, +"predictedDocumentCount": { +"description": "The amount of documents with a predicted occurrence.", +"format": "int32", +"type": "integer" +}, +"predictedOccurrencesCount": { +"description": "The amount of occurrences in predicted documents.", +"format": "int32", +"type": "integer" +}, +"recall": { +"description": "The calculated recall.", +"format": "float", +"type": "number" +}, +"totalDocumentsCount": { +"description": "The amount of documents that had an occurrence of this label.", +"format": "int32", +"type": "integer" +}, +"truePositivesCount": { +"description": "The amount of true positives.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3EvaluationReference": { +"description": "Gives a short summary of an evaluation, and links to the evaluation itself.", +"id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", +"properties": { +"aggregateMetrics": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", +"description": "An aggregate of the statistics for the evaluation with fuzzy matching on." +}, +"aggregateMetricsExact": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", +"description": "An aggregate of the statistics for the evaluation with fuzzy matching off." +}, +"evaluation": { +"description": "The resource name of the evaluation.", +"type": "string" +}, +"operation": { +"description": "The resource name of the Long Running Operation for the evaluation.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": { "description": "Metadata of the batch export documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata", @@ -1817,27 +2435,92 @@ }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { -"description": "Metadata of the import document operation.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", +"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": { +"description": "Metadata for how this field value is extracted.", +"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"entityQuery": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", +"description": "Entity query config." }, -"importConfigValidationResults": { -"description": "Validation statuses of the batch documents import config.", -"items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" +"summaryOptions": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", +"description": "Summary options config." +} }, -"type": "array" +"type": "object" }, -"individualImportStatuses": { -"description": "The list of response details of each document.", -"items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" +"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": { +"description": "Message for entity query.", +"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", +"properties": { +"userEntityQuery": { +"description": "The original entity query inputed by the user.", +"type": "string" +} }, -"type": "array" +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": { +"description": "Metadata for the field tier of a property.", +"id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", +"properties": { +"tierLevel": { +"description": "Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": { +"description": "Metadata for human review labeling config.", +"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", +"properties": { +"enableNormalizationEditing": { +"description": "Whether to enable normalization editing.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": { +"description": "Metadata for Human Review config.", +"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", +"properties": { +"confidenceThreshold": { +"description": "The confidence threshold if human review validation is enabled.", +"format": "float", +"type": "number" +}, +"enableValidation": { +"description": "Whether to enable human review validation.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { +"description": "Metadata of the import document operation.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +}, +"importConfigValidationResults": { +"description": "Validation statuses of the batch documents import config.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" +}, +"type": "array" +}, +"individualImportStatuses": { +"description": "The list of response details of each document.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" +}, +"type": "array" }, "totalDocumentCount": { "description": "Total number of the documents that are qualified for importing.", @@ -1913,273 +2596,450 @@ }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": { -"description": "The metadata proto of `ResyncDataset` method.", -"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata", +"GoogleCloudDocumentaiUiv1beta3Processor": { +"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", +"id": "GoogleCloudDocumentaiUiv1beta3Processor", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"activeSchemaVersion": { +"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", +"type": "string" }, -"datasetResyncStatuses": { -"description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.", -"items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" +"createTime": { +"description": "Output only. The time the processor was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"type": "array" +"defaultProcessorVersion": { +"description": "The default processor version.", +"type": "string" }, -"individualDocumentResyncStatuses": { -"description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", +"displayName": { +"description": "The display name of the processor.", +"type": "string" +}, +"kmsKeyName": { +"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", +"type": "string" +}, +"name": { +"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", +"readOnly": true, +"type": "string" +}, +"processEndpoint": { +"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", +"readOnly": true, +"type": "string" +}, +"processorVersionAliases": { +"description": "Output only. The processor version aliases.", "items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" }, -"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { -"description": "Resync status against inconsistency types on the dataset level.", -"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", -"properties": { -"datasetInconsistencyType": { -"description": "The type of the inconsistency of the dataset.", +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the processor.", "enum": [ -"DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", -"DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED", +"ENABLING", +"DISABLING", +"CREATING", +"FAILED", +"DELETING" ], "enumDescriptions": [ -"Default value.", -"The marker file under the dataset folder is not found." +"The processor is in an unspecified state.", +"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", +"The processor is disabled.", +"The processor is being enabled, will become `ENABLED` if successful.", +"The processor is being disabled, will become `DISABLED` if successful.", +"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", +"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", +"The processor is being deleted, will be removed if successful." ], +"readOnly": true, "type": "string" }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." +"type": { +"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { -"description": "Resync status for each document per inconsistency type.", -"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersion": { +"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion", "properties": { -"documentId": { -"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", -"description": "The document identifier." +"createTime": { +"description": "Output only. The time the processor version was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"documentInconsistencyType": { -"description": "The type of document inconsistency.", -"enum": [ -"DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", -"DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", -"DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", -"DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" -], -"enumDescriptions": [ -"Default value.", -"The document proto is invalid.", -"Indexed docproto metadata is mismatched.", -"The page image or thumbnails are missing." -], +"deploymentAllowed": { +"description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.", +"readOnly": true, +"type": "boolean" +}, +"deprecationInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", +"description": "Output only. If set, information about the eventual deprecation of this version.", +"readOnly": true +}, +"displayName": { +"description": "The display name of the processor version.", "type": "string" }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." -} +"documentSchema": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", +"description": "Output only. The schema of the processor version. Describes the output.", +"readOnly": true }, -"type": "object" +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true }, -"GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": { -"description": "The response proto of ResyncDataset method.", -"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse", -"properties": {}, -"type": "object" +"googleManaged": { +"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", +"readOnly": true, +"type": "boolean" }, -"GoogleCloudDocumentaiUiv1beta3RevisionRef": { -"description": "The revision reference specifies which revision on the document to read.", -"id": "GoogleCloudDocumentaiUiv1beta3RevisionRef", -"properties": { -"latestProcessorVersion": { -"description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", +"kmsKeyName": { +"description": "Output only. The KMS key name used for encryption.", +"readOnly": true, "type": "string" }, -"revisionCase": { -"description": "Reads the revision by the predefined case.", +"kmsKeyVersionName": { +"description": "Output only. The KMS key version with which data is encrypted.", +"readOnly": true, +"type": "string" +}, +"latestEvaluation": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", +"description": "Output only. The most recently invoked evaluation for the processor version.", +"readOnly": true +}, +"modelType": { +"description": "Output only. The model type of this processor version.", "enum": [ -"REVISION_CASE_UNSPECIFIED", -"LATEST_HUMAN_REVIEW", -"LATEST_TIMESTAMP", -"BASE_OCR_REVISION" +"MODEL_TYPE_UNSPECIFIED", +"MODEL_TYPE_GENERATIVE", +"MODEL_TYPE_CUSTOM" ], "enumDescriptions": [ -"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", -"The latest revision made by a human.", -"The latest revision based on timestamp.", -"The first (OCR) revision." +"The processor version has unspecified model type.", +"The processor version has generative model type.", +"The processor version has custom model type." ], +"readOnly": true, "type": "string" }, -"revisionId": { -"description": "Reads the revision given by the id.", +"name": { +"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", "type": "string" -} }, -"type": "object" +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" }, -"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { -"description": "Metadata of the sample documents operation.", -"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", -"properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." -} +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" }, -"type": "object" +"schema": { +"$ref": "GoogleCloudDocumentaiUiv1beta3Schema", +"description": "The schema of the processor version. Describes the output." }, -"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { -"description": "Response of the sample documents operation.", -"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", -"properties": { -"sampleTestStatus": { -"$ref": "GoogleRpcStatus", -"description": "The status of sampling documents in test split." +"state": { +"description": "Output only. The state of the processor version.", +"enum": [ +"STATE_UNSPECIFIED", +"DEPLOYED", +"DEPLOYING", +"UNDEPLOYED", +"UNDEPLOYING", +"CREATING", +"DELETING", +"FAILED", +"IMPORTING" +], +"enumDescriptions": [ +"The processor version is in an unspecified state.", +"The processor version is deployed and can be used for processing.", +"The processor version is being deployed.", +"The processor version is not deployed and cannot be used for processing.", +"The processor version is being undeployed.", +"The processor version is being created.", +"The processor version is being deleted.", +"The processor version failed and is in an indeterminate state.", +"The processor version is being imported." +], +"readOnly": true, +"type": "string" +} }, -"sampleTrainingStatus": { -"$ref": "GoogleRpcStatus", -"description": "The status of sampling documents in training split." +"type": "object" }, -"selectedDocuments": { -"description": "The result of the sampling process.", -"items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": { +"description": "Contains the alias and the aliased resource name of processor version.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias", +"properties": { +"alias": { +"description": "The alias in the form of `processor_version` resource name.", +"type": "string" }, -"type": "array" +"processorVersion": { +"description": "The resource name of aliased processor version.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { -"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": { +"description": "Information about the upcoming deprecation of this processor version.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", "properties": { -"documentId": { -"description": "An internal identifier for document.", +"deprecationTime": { +"description": "The time at which this processor version will be deprecated.", +"format": "google-datetime", +"type": "string" +}, +"replacementProcessorVersion": { +"description": "If set, the processor version that will be used as a replacement.", "type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { -"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", -"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." +}, +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": { -"description": "Response message for the SetDefaultProcessorVersion method.", -"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse", -"properties": {}, +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"properties": { +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", +"type": "string" +}, +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { -"description": "The metadata that represents a processor version being created.", -"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" }, -"testDatasetValidation": { -"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", -"description": "The test dataset validation information." +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" +} }, -"trainingDatasetValidation": { -"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", -"description": "The training dataset validation information." +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3PropertyMetadata": { +"description": "Metadata about a property.", +"id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", +"properties": { +"fieldExtractionMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", +"description": "Field extraction metadata on the property." +}, +"fieldTierMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", +"description": "Field tier metadata on the property" +}, +"humanReviewLabelingMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", +"description": "Human review labeling config on the property." +}, +"humanReviewMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", +"description": "Human review validation config on the property." +}, +"inactive": { +"description": "Whether the property should be considered as \"inactive\".", +"type": "boolean" +}, +"schemaEditabilityMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", +"description": "Schema editability metadata on the property." +}, +"schemaInferenceMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", +"description": "Schema inference metadata on the property." } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": { -"description": "The dataset validation information. This includes any and all errors with documents and the dataset.", -"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", +"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata": { +"description": "The metadata proto of `ResyncDataset` method.", +"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadata", "properties": { -"datasetErrorCount": { -"description": "The total number of dataset errors.", -"format": "int32", -"type": "integer" +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." }, -"datasetErrors": { -"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", +"datasetResyncStatuses": { +"description": "The list of dataset resync statuses. Not checked when ResyncDatasetRequest.dataset_documents is specified.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus" }, "type": "array" }, -"documentErrorCount": { -"description": "The total number of document errors.", -"format": "int32", -"type": "integer" -}, -"documentErrors": { -"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", +"individualDocumentResyncStatuses": { +"description": "The list of document resync statuses. The same document could have multiple `individual_document_resync_statuses` if it has multiple inconsistencies.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { -"description": "The response for TrainProcessorVersion.", -"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", +"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus": { +"description": "Resync status against inconsistency types on the dataset level.", +"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataDatasetResyncStatus", "properties": { -"processorVersion": { -"description": "The resource name of the processor version produced by training.", +"datasetInconsistencyType": { +"description": "The type of the inconsistency of the dataset.", +"enum": [ +"DATASET_INCONSISTENCY_TYPE_UNSPECIFIED", +"DATASET_INCONSISTENCY_TYPE_NO_STORAGE_MARKER" +], +"enumDescriptions": [ +"Default value.", +"The marker file under the dataset folder is not found." +], "type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of resyncing the dataset with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { -"description": "The long-running operation metadata for the UndeployProcessorVersion method.", -"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", +"GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus": { +"description": "Resync status for each document per inconsistency type.", +"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetMetadataIndividualDocumentResyncStatus", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"documentId": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", +"description": "The document identifier." +}, +"documentInconsistencyType": { +"description": "The type of document inconsistency.", +"enum": [ +"DOCUMENT_INCONSISTENCY_TYPE_UNSPECIFIED", +"DOCUMENT_INCONSISTENCY_TYPE_INVALID_DOCPROTO", +"DOCUMENT_INCONSISTENCY_TYPE_MISMATCHED_METADATA", +"DOCUMENT_INCONSISTENCY_TYPE_NO_PAGE_IMAGE" +], +"enumDescriptions": [ +"Default value.", +"The document proto is invalid.", +"Indexed docproto metadata is mismatched.", +"The page image or thumbnails are missing." +], +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of resyncing the document with regards to the detected inconsistency. Empty if ResyncDatasetRequest.validate_only is `true`." } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": { -"description": "Response message for the UndeployProcessorVersion method.", -"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse", +"GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse": { +"description": "The response proto of ResyncDataset method.", +"id": "GoogleCloudDocumentaiUiv1beta3ResyncDatasetResponse", "properties": {}, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": { -"id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata", +"GoogleCloudDocumentaiUiv1beta3RevisionRef": { +"description": "The revision reference specifies which revision on the document to read.", +"id": "GoogleCloudDocumentaiUiv1beta3RevisionRef", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"latestProcessorVersion": { +"description": "Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", +"type": "string" +}, +"revisionCase": { +"description": "Reads the revision by the predefined case.", +"enum": [ +"REVISION_CASE_UNSPECIFIED", +"LATEST_HUMAN_REVIEW", +"LATEST_TIMESTAMP", +"BASE_OCR_REVISION" +], +"enumDescriptions": [ +"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", +"The latest revision made by a human.", +"The latest revision based on timestamp.", +"The first (OCR) revision." +], +"type": "string" +}, +"revisionId": { +"description": "Reads the revision given by the id.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { -"description": "The long-running operation metadata for updating the human review configuration.", -"id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", +"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { +"description": "Metadata of the sample documents operation.", +"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", "properties": { "commonMetadata": { "$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", @@ -2188,188 +3048,517 @@ }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { -"description": "The long-running operation metadata for UpdateLabelerPool.", -"id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", +"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { +"description": "Response of the sample documents operation.", +"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"sampleTestStatus": { +"$ref": "GoogleRpcStatus", +"description": "The status of sampling documents in test split." +}, +"sampleTrainingStatus": { +"$ref": "GoogleRpcStatus", +"description": "The status of sampling documents in training split." +}, +"selectedDocuments": { +"description": "The result of the sampling process.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDocumentaiV1Barcode": { -"description": "Encodes the detailed information of a barcode.", -"id": "GoogleCloudDocumentaiV1Barcode", +"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { +"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", "properties": { -"format": { -"description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", +"documentId": { +"description": "An internal identifier for document.", "type": "string" +} }, -"rawValue": { -"description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3Schema": { +"description": "The schema defines the output of the processed document by a processor.", +"id": "GoogleCloudDocumentaiUiv1beta3Schema", +"properties": { +"description": { +"description": "Description of the schema.", "type": "string" }, -"valueFormat": { -"description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", +"displayName": { +"description": "Display name to show to users.", "type": "string" +}, +"entityTypes": { +"description": "Entity types of the schema.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDocumentaiV1BatchDocumentsInputConfig": { -"description": "The common config to specify a set of documents used as input.", -"id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", +"GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": { +"description": "Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.", +"id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", "properties": { -"gcsDocuments": { -"$ref": "GoogleCloudDocumentaiV1GcsDocuments", -"description": "The set of documents individually specified on Cloud Storage." +"editable": { +"description": "Explicit flag that controls whether the label is editable.", +"type": "boolean" }, -"gcsPrefix": { -"$ref": "GoogleCloudDocumentaiV1GcsPrefix", -"description": "The set of documents that match the specified Cloud Storage `gcs_prefix`." +"processorVersions": { +"description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDocumentaiV1BatchProcessMetadata": { -"description": "The long-running operation metadata for BatchProcessDocuments.", -"id": "GoogleCloudDocumentaiV1BatchProcessMetadata", +"GoogleCloudDocumentaiUiv1beta3SchemaEntityType": { +"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", +"id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType", "properties": { -"createTime": { -"description": "The creation time of the operation.", -"format": "google-datetime", +"baseType": { "type": "string" }, -"individualProcessStatuses": { -"description": "The list of response details of each document.", +"description": { +"description": "Description of the entity type.", +"type": "string" +}, +"enumValues": { +"description": "If specified, lists all the possible values for this entity.", "items": { -"$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus" +"type": "string" }, "type": "array" }, -"state": { -"description": "The state of the current batch processing.", +"hide": { +"description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.", +"type": "boolean" +}, +"method": { +"description": "Specifies how the entity's value is obtained.", "enum": [ -"STATE_UNSPECIFIED", -"WAITING", -"RUNNING", -"SUCCEEDED", -"CANCELLING", -"CANCELLED", -"FAILED" +"METHOD_UNSPECIFIED", +"EXTRACT", +"DERIVE" ], "enumDescriptions": [ -"The default value. This value is used if the state is omitted.", -"Request operation is waiting for scheduling.", -"Request is being processed.", -"The batch processing completed successfully.", -"The batch processing was being cancelled.", -"The batch processing was cancelled.", -"The batch processing has failed." +"Unspecified method. It defaults to `EXTRACT`.", +"The entity's value is directly extracted as-is from the document text.", +"The entity's value is derived through inference and is not necessarily an exact text extraction from the document." ], "type": "string" }, -"stateMessage": { -"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", +"occurrenceType": { +"description": "Occurrence type limits the number of times an entity type appears in the document.", +"enum": [ +"OCCURRENCE_TYPE_UNSPECIFIED", +"OPTIONAL_ONCE", +"OPTIONAL_MULTIPLE", +"REQUIRED_ONCE", +"REQUIRED_MULTIPLE" +], +"enumDescriptions": [ +"Unspecified occurrence type.", +"The entity type will appear zero times or once.", +"The entity type will appear zero or multiple times.", +"The entity type will only appear exactly once.", +"The entity type will appear once or more times." +], "type": "string" }, -"updateTime": { -"description": "The last update time of the operation.", -"format": "google-datetime", +"properties": { +"description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" +}, +"type": "array" +}, +"source": { +"description": "Source of this entity type.", +"enum": [ +"SOURCE_UNSPECIFIED", +"PREDEFINED", +"USER_INPUT" +], +"enumDescriptions": [ +"Unspecified source.", +"The entity type is in the predefined schema of a pretrained version of a processor.", +"The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor." +], +"type": "string" +}, +"type": { +"description": "Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: \"google\", \"DocumentAI\" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., \"line_item/amount\") in which case each part (e.g., \"line_item\", \"amount\") must comply with the rules defined above. We recommend using the snake case (\"snake_case\") in entity type names.", "type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": { -"description": "The status of a each individual document in the batch process.", -"id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus", +"GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": { +"description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.", +"id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", "properties": { -"humanReviewStatus": { -"$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", -"description": "The status of human review on the processed document." -}, -"inputGcsSource": { -"description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.", -"type": "string" +"inferred": { +"description": "True if is inferred by schema inference.", +"type": "boolean" +} }, -"outputGcsDestination": { -"description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.", -"type": "string" +"type": "object" }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status processing the document." +"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata": { +"description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." } }, "type": "object" }, -"GoogleCloudDocumentaiV1BatchProcessRequest": { -"description": "Request message for BatchProcessDocuments.", -"id": "GoogleCloudDocumentaiV1BatchProcessRequest", -"properties": { -"documentOutputConfig": { -"$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig", -"description": "The output configuration for the BatchProcessDocuments method." +"GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse": { +"description": "Response message for the SetDefaultProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3SetDefaultProcessorVersionResponse", +"properties": {}, +"type": "object" }, -"inputDocuments": { -"$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", -"description": "The input documents for the BatchProcessDocuments method." +"GoogleCloudDocumentaiUiv1beta3SummaryOptions": { +"description": "Metadata for document summarization.", +"id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", +"properties": { +"format": { +"description": "The format the summary should be in.", +"enum": [ +"FORMAT_UNSPECIFIED", +"PARAGRAPH", +"BULLETS" +], +"enumDescriptions": [ +"Default.", +"Format the output in paragraphs.", +"Format the output in bullets." +], +"type": "string" }, -"labels": { -"additionalProperties": { +"length": { +"description": "How long the summary should be.", +"enum": [ +"LENGTH_UNSPECIFIED", +"BRIEF", +"MODERATE", +"COMPREHENSIVE" +], +"enumDescriptions": [ +"Default.", +"A brief summary of one or two sentences.", +"A paragraph-length summary.", +"The longest option available." +], "type": "string" +} }, -"description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", "type": "object" }, -"processOptions": { -"$ref": "GoogleCloudDocumentaiV1ProcessOptions", -"description": "Inference-time options for the process API" +"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { +"description": "The metadata that represents a processor version being created.", +"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." }, -"skipHumanReview": { -"description": "Whether human review should be skipped for this request. Default to `false`.", -"type": "boolean" -} +"testDatasetValidation": { +"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", +"description": "The test dataset validation information." }, -"type": "object" +"trainingDatasetValidation": { +"$ref": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", +"description": "The training dataset validation information." +} }, -"GoogleCloudDocumentaiV1BatchProcessResponse": { -"description": "Response message for BatchProcessDocuments.", -"id": "GoogleCloudDocumentaiV1BatchProcessResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDocumentaiV1BoundingPoly": { -"description": "A bounding polygon for the detected image annotation.", -"id": "GoogleCloudDocumentaiV1BoundingPoly", +"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation": { +"description": "The dataset validation information. This includes any and all errors with documents and the dataset.", +"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadataDatasetValidation", "properties": { -"normalizedVertices": { -"description": "The bounding polygon normalized vertices.", +"datasetErrorCount": { +"description": "The total number of dataset errors.", +"format": "int32", +"type": "integer" +}, +"datasetErrors": { +"description": "Error information for the dataset as a whole. A maximum of 10 dataset errors will be returned. A single dataset error is terminal for training.", "items": { -"$ref": "GoogleCloudDocumentaiV1NormalizedVertex" +"$ref": "GoogleRpcStatus" }, "type": "array" }, -"vertices": { -"description": "The bounding polygon vertices.", +"documentErrorCount": { +"description": "The total number of document errors.", +"format": "int32", +"type": "integer" +}, +"documentErrors": { +"description": "Error information pertaining to specific documents. A maximum of 10 document errors will be returned. Any document with errors will not be used throughout training.", "items": { -"$ref": "GoogleCloudDocumentaiV1Vertex" +"$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDocumentaiV1CommonOperationMetadata": { -"description": "The common metadata for long running operations.", -"id": "GoogleCloudDocumentaiV1CommonOperationMetadata", +"GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse": { +"description": "The response for TrainProcessorVersion.", +"id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionResponse", "properties": { -"createTime": { -"description": "The creation time of the operation.", -"format": "google-datetime", +"processorVersion": { +"description": "The resource name of the processor version produced by training.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata": { +"description": "The long-running operation metadata for the UndeployProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse": { +"description": "Response message for the UndeployProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3UndeployProcessorVersionResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata": { +"id": "GoogleCloudDocumentaiUiv1beta3UpdateDatasetOperationMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata": { +"description": "The long-running operation metadata for updating the human review configuration.", +"id": "GoogleCloudDocumentaiUiv1beta3UpdateHumanReviewConfigMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata": { +"description": "The long-running operation metadata for UpdateLabelerPool.", +"id": "GoogleCloudDocumentaiUiv1beta3UpdateLabelerPoolOperationMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": { +"description": "The long-running operation metadata for the UpdateProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata for the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1Barcode": { +"description": "Encodes the detailed information of a barcode.", +"id": "GoogleCloudDocumentaiV1Barcode", +"properties": { +"format": { +"description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", +"type": "string" +}, +"rawValue": { +"description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", +"type": "string" +}, +"valueFormat": { +"description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1BatchDocumentsInputConfig": { +"description": "The common config to specify a set of documents used as input.", +"id": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", +"properties": { +"gcsDocuments": { +"$ref": "GoogleCloudDocumentaiV1GcsDocuments", +"description": "The set of documents individually specified on Cloud Storage." +}, +"gcsPrefix": { +"$ref": "GoogleCloudDocumentaiV1GcsPrefix", +"description": "The set of documents that match the specified Cloud Storage `gcs_prefix`." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1BatchProcessMetadata": { +"description": "The long-running operation metadata for BatchProcessDocuments.", +"id": "GoogleCloudDocumentaiV1BatchProcessMetadata", +"properties": { +"createTime": { +"description": "The creation time of the operation.", +"format": "google-datetime", +"type": "string" +}, +"individualProcessStatuses": { +"description": "The list of response details of each document.", +"items": { +"$ref": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus" +}, +"type": "array" +}, +"state": { +"description": "The state of the current batch processing.", +"enum": [ +"STATE_UNSPECIFIED", +"WAITING", +"RUNNING", +"SUCCEEDED", +"CANCELLING", +"CANCELLED", +"FAILED" +], +"enumDescriptions": [ +"The default value. This value is used if the state is omitted.", +"Request operation is waiting for scheduling.", +"Request is being processed.", +"The batch processing completed successfully.", +"The batch processing was being cancelled.", +"The batch processing was cancelled.", +"The batch processing has failed." +], +"type": "string" +}, +"stateMessage": { +"description": "A message providing more details about the current state of processing. For example, the error message if the operation is failed.", +"type": "string" +}, +"updateTime": { +"description": "The last update time of the operation.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus": { +"description": "The status of a each individual document in the batch process.", +"id": "GoogleCloudDocumentaiV1BatchProcessMetadataIndividualProcessStatus", +"properties": { +"humanReviewStatus": { +"$ref": "GoogleCloudDocumentaiV1HumanReviewStatus", +"description": "The status of human review on the processed document." +}, +"inputGcsSource": { +"description": "The source of the document, same as the input_gcs_source field in the request when the batch process started.", +"type": "string" +}, +"outputGcsDestination": { +"description": "The Cloud Storage output destination (in the request as DocumentOutputConfig.GcsOutputConfig.gcs_uri) of the processed document if it was successful, otherwise empty.", +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status processing the document." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1BatchProcessRequest": { +"description": "Request message for BatchProcessDocuments.", +"id": "GoogleCloudDocumentaiV1BatchProcessRequest", +"properties": { +"documentOutputConfig": { +"$ref": "GoogleCloudDocumentaiV1DocumentOutputConfig", +"description": "The output configuration for the BatchProcessDocuments method." +}, +"inputDocuments": { +"$ref": "GoogleCloudDocumentaiV1BatchDocumentsInputConfig", +"description": "The input documents for the BatchProcessDocuments method." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", +"type": "object" +}, +"processOptions": { +"$ref": "GoogleCloudDocumentaiV1ProcessOptions", +"description": "Inference-time options for the process API" +}, +"skipHumanReview": { +"description": "Whether human review should be skipped for this request. Default to `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1BatchProcessResponse": { +"description": "Response message for BatchProcessDocuments.", +"id": "GoogleCloudDocumentaiV1BatchProcessResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDocumentaiV1BoundingPoly": { +"description": "A bounding polygon for the detected image annotation.", +"id": "GoogleCloudDocumentaiV1BoundingPoly", +"properties": { +"normalizedVertices": { +"description": "The bounding polygon normalized vertices.", +"items": { +"$ref": "GoogleCloudDocumentaiV1NormalizedVertex" +}, +"type": "array" +}, +"vertices": { +"description": "The bounding polygon vertices.", +"items": { +"$ref": "GoogleCloudDocumentaiV1Vertex" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1CommonOperationMetadata": { +"description": "The common metadata for long running operations.", +"id": "GoogleCloudDocumentaiV1CommonOperationMetadata", +"properties": { +"createTime": { +"description": "The creation time of the operation.", +"format": "google-datetime", "type": "string" }, "resource": { @@ -3035,12 +4224,16 @@ "description": "Validation result for a single validation rule.", "id": "GoogleCloudDocumentaiV1DocumentEntityValidationOutputValidationResult", "properties": { +"rule": { +"description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`", +"type": "string" +}, "ruleDescription": { "description": "The description of the validation rule.", "type": "string" }, "ruleName": { -"description": "The name of the validation rule.", +"description": "The display name of the validation rule.", "type": "string" }, "validationDetails": { @@ -4250,6 +5443,20 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1Documents": { +"description": "A set of inline documents.", +"id": "GoogleCloudDocumentaiV1Documents", +"properties": { +"documents": { +"description": "The list of documents.", +"items": { +"$ref": "GoogleCloudDocumentaiV1Document" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1EnableProcessorMetadata": { "description": "The long-running operation metadata for the EnableProcessor method.", "id": "GoogleCloudDocumentaiV1EnableProcessorMetadata", @@ -4580,20 +5787,77 @@ true }, "type": "object" }, -"GoogleCloudDocumentaiV1HumanReviewStatus": { -"description": "The status of human review on a processed document.", -"id": "GoogleCloudDocumentaiV1HumanReviewStatus", +"GoogleCloudDocumentaiV1GenerateSchemaVersionRequest": { +"description": "Request message for GenerateSchemaVersion.", +"id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequest", "properties": { -"humanReviewOperation": { -"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", +"baseSchemaVersion": { +"description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", "type": "string" }, -"state": { -"description": "The state of human review on the processing request.", -"enum": [ -"STATE_UNSPECIFIED", -"SKIPPED", -"VALIDATION_PASSED", +"gcsDocuments": { +"$ref": "GoogleCloudDocumentaiV1GcsDocuments", +"description": "The set of documents placed on Cloud Storage." +}, +"gcsPrefix": { +"$ref": "GoogleCloudDocumentaiV1GcsPrefix", +"description": "The common prefix of documents placed on Cloud Storage." +}, +"generateSchemaVersionParams": { +"$ref": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams", +"description": "Optional. User specified parameters for the schema generation." +}, +"inlineDocuments": { +"$ref": "GoogleCloudDocumentaiV1Documents", +"description": "The set of documents specified inline." +}, +"rawDocuments": { +"$ref": "GoogleCloudDocumentaiV1RawDocuments", +"description": "The set of raw documents." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams": { +"description": "The parameters for the schema generation.", +"id": "GoogleCloudDocumentaiV1GenerateSchemaVersionRequestGenerateSchemaVersionParams", +"properties": { +"history": { +"$ref": "GoogleCloudDocumentaiV1SchemaGenerationHistory", +"description": "Optional. Previous prompt-answers in a chronological order." +}, +"prompt": { +"description": "Optional. The prompt used for the schema generation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1GenerateSchemaVersionResponse": { +"description": "Response message for GenerateSchemaVersion.", +"id": "GoogleCloudDocumentaiV1GenerateSchemaVersionResponse", +"properties": { +"schemaVersion": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion", +"description": "The schema version generated by the model." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1HumanReviewStatus": { +"description": "The status of human review on a processed document.", +"id": "GoogleCloudDocumentaiV1HumanReviewStatus", +"properties": { +"humanReviewOperation": { +"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", +"type": "string" +}, +"state": { +"description": "The state of human review on the processing request.", +"enum": [ +"STATE_UNSPECIFIED", +"SKIPPED", +"VALIDATION_PASSED", "IN_PROGRESS", "ERROR" ], @@ -4685,6 +5949,76 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1ListSchemaVersionsResponse": { +"description": "Response message for ListSchemaVersions.", +"id": "GoogleCloudDocumentaiV1ListSchemaVersionsResponse", +"properties": { +"nextPageToken": { +"description": "Points to the next SchemaVersion, otherwise empty.", +"type": "string" +}, +"schemaVersions": { +"description": "The list of SchemaVersions.", +"items": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1ListSchemasResponse": { +"description": "Response message for ListSchemas.", +"id": "GoogleCloudDocumentaiV1ListSchemasResponse", +"properties": { +"nextPageToken": { +"description": "Points to the next Schema, otherwise empty.", +"type": "string" +}, +"schemas": { +"description": "The list of Schemas.", +"items": { +"$ref": "GoogleCloudDocumentaiV1NextSchema" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1NextSchema": { +"description": "NextSchema is a collection of SchemaVersions.", +"id": "GoogleCloudDocumentaiV1NextSchema", +"properties": { +"createTime": { +"description": "Output only. The time when the Schema was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The user-defined name of the Schema.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The GCP labels for the Schema.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the Schema was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1NormalizedVertex": { "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudDocumentaiV1NormalizedVertex", @@ -4834,6 +6168,14 @@ true "$ref": "GoogleCloudDocumentaiV1ProcessOptionsLayoutConfigChunkingConfig", "description": "Optional. Config for chunking in layout parser processor." }, +"enableImageAnnotation": { +"description": "Optional. Whether to include image annotations in layout parser response.", +"type": "boolean" +}, +"enableTableAnnotation": { +"description": "Optional. Whether to include table annotations in layout parser response.", +"type": "boolean" +}, "returnBoundingBoxes": { "description": "Optional. Whether to include bounding boxes in layout parser processor response.", "type": "boolean" @@ -4923,6 +6265,10 @@ true "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", "id": "GoogleCloudDocumentaiV1Processor", "properties": { +"activeSchemaVersion": { +"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", +"type": "string" +}, "createTime": { "description": "Output only. The time the processor was created.", "format": "google-datetime", @@ -5288,6 +6634,20 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1RawDocuments": { +"description": "Specifies a set of raw documents.", +"id": "GoogleCloudDocumentaiV1RawDocuments", +"properties": { +"documents": { +"description": "Specifies raw document content and mime type.", +"items": { +"$ref": "GoogleCloudDocumentaiV1RawDocument" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata": { "description": "The long-running operation metadata for the ReviewDocument method.", "id": "GoogleCloudDocumentaiV1ReviewDocumentOperationMetadata", @@ -5363,6 +6723,71 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1SchemaGenerationHistory": { +"description": "The history of schema generation iterations.", +"id": "GoogleCloudDocumentaiV1SchemaGenerationHistory", +"properties": { +"iterations": { +"description": "Required. Previous prompt-answers in a chronological order.", +"items": { +"$ref": "GoogleCloudDocumentaiV1SchemaGenerationIteration" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1SchemaGenerationIteration": { +"description": "A single iteration of the schema generation.", +"id": "GoogleCloudDocumentaiV1SchemaGenerationIteration", +"properties": { +"adjustedSchema": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion", +"description": "Optional. The previous schema version adjusted by the model." +}, +"generatedSchema": { +"$ref": "GoogleCloudDocumentaiV1SchemaVersion", +"description": "Required. The schema version generated by the model." +}, +"prompt": { +"description": "Optional. The prompt used for the iteration.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1SchemaVersion": { +"description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.", +"id": "GoogleCloudDocumentaiV1SchemaVersion", +"properties": { +"createTime": { +"description": "Output only. The time when the SchemaVersion was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The user-defined name of the SchemaVersion.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The GCP labels for the SchemaVersion.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"type": "string" +}, +"schema": { +"$ref": "GoogleCloudDocumentaiV1DocumentSchema", +"description": "Required. The schema of the SchemaVersion." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata": { "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", "id": "GoogleCloudDocumentaiV1SetDefaultProcessorVersionMetadata", @@ -5949,177 +7374,743 @@ true }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { -"description": "The long-running operation metadata for the EnableProcessor method.", -"id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", +"GoogleCloudDocumentaiV1beta3DocumentSchema": { +"description": "The schema defines the output of the processed document by a processor.", +"id": "GoogleCloudDocumentaiV1beta3DocumentSchema", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"description": { +"description": "Description of the schema.", +"type": "string" +}, +"displayName": { +"description": "Display name to show to users.", +"type": "string" +}, +"entityTypes": { +"description": "Entity types of the schema.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType" +}, +"type": "array" +}, +"metadata": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata", +"description": "Metadata of the schema." } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3EnableProcessorResponse": { -"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.", -"id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse", -"properties": {}, +"GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType": { +"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", +"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityType", +"properties": { +"baseTypes": { +"description": "The entity type that this type is derived from. For now, one and only one should be set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", +"type": "string" +}, +"displayName": { +"description": "User defined name for the type.", +"type": "string" +}, +"entityTypeMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata", +"description": "Metadata for the entity type." +}, +"enumValues": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues", +"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." +}, +"name": { +"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", +"type": "string" +}, +"properties": { +"description": "Description the nested structure, or composition of an entity.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty" +}, +"type": "array" +} +}, "type": "object" }, -"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": { -"description": "Metadata of the EvaluateProcessorVersion method.", -"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata", +"GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues": { +"description": "Defines the a list of enum values.", +"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeEnumValues", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." +"values": { +"description": "The individual values that this enum values type can include.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty": { +"description": "Defines properties that can be part of the entity type.", +"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty", +"properties": { +"description": { +"description": "The description of the property. Could be used to provide more information about the property for model calls.", +"type": "string" +}, +"displayName": { +"description": "User defined name for the property.", +"type": "string" +}, +"method": { +"description": "Specifies how the entity's value is obtained.", +"enum": [ +"METHOD_UNSPECIFIED", +"EXTRACT", +"DERIVE" +], +"enumDescriptions": [ +"Unspecified method. It defaults to `EXTRACT`.", +"The entity's value is directly extracted as-is from the document text.", +"The entity's value is derived through inference and is not necessarily an exact text extraction from the document." +], +"type": "string" +}, +"name": { +"description": "The name of the property. Follows the same guidelines as the EntityType name.", +"type": "string" +}, +"occurrenceType": { +"description": "Occurrence type limits the number of instances an entity type appears in the document.", +"enum": [ +"OCCURRENCE_TYPE_UNSPECIFIED", +"OPTIONAL_ONCE", +"OPTIONAL_MULTIPLE", +"REQUIRED_ONCE", +"REQUIRED_MULTIPLE" +], +"enumDescriptions": [ +"Unspecified occurrence type.", +"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", +"The entity type will appear zero or multiple times.", +"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", +"The entity type will appear once or more times." +], +"type": "string" +}, +"propertyMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3PropertyMetadata", +"description": "Any additional metadata about the property can be added here." +}, +"valueType": { +"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata": { +"description": "Metadata for global schema behavior.", +"id": "GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata", +"properties": { +"documentAllowMultipleLabels": { +"description": "If true, on a given page, there can be multiple `document` annotations covering it.", +"type": "boolean" +}, +"documentSplitter": { +"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", +"type": "boolean" +}, +"prefixedNamingOnProperties": { +"description": "If set, all the nested entities must be prefixed with the parents.", +"type": "boolean" +}, +"skipNamingValidation": { +"description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { +"description": "The long-running operation metadata for the EnableProcessor method.", +"id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EnableProcessorResponse": { +"description": "Response message for the EnableProcessor method. Intentionally empty proto for adding fields in future.", +"id": "GoogleCloudDocumentaiV1beta3EnableProcessorResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EntityTypeMetadata": { +"description": "Metadata about an entity type.", +"id": "GoogleCloudDocumentaiV1beta3EntityTypeMetadata", +"properties": { +"inactive": { +"description": "Whether the entity type should be considered inactive.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata": { +"description": "Metadata of the EvaluateProcessorVersion method.", +"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { +"description": "Response of the EvaluateProcessorVersion method.", +"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", +"properties": { +"evaluation": { +"description": "The resource name of the created evaluation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EvaluationMetrics": { +"description": "Evaluation metrics, either in aggregate or about a specific entity.", +"id": "GoogleCloudDocumentaiV1beta3EvaluationMetrics", +"properties": { +"f1Score": { +"description": "The calculated f1 score.", +"format": "float", +"type": "number" +}, +"falseNegativesCount": { +"description": "The amount of false negatives.", +"format": "int32", +"type": "integer" +}, +"falsePositivesCount": { +"description": "The amount of false positives.", +"format": "int32", +"type": "integer" +}, +"groundTruthDocumentCount": { +"description": "The amount of documents with a ground truth occurrence.", +"format": "int32", +"type": "integer" +}, +"groundTruthOccurrencesCount": { +"description": "The amount of occurrences in ground truth documents.", +"format": "int32", +"type": "integer" +}, +"precision": { +"description": "The calculated precision.", +"format": "float", +"type": "number" +}, +"predictedDocumentCount": { +"description": "The amount of documents with a predicted occurrence.", +"format": "int32", +"type": "integer" +}, +"predictedOccurrencesCount": { +"description": "The amount of occurrences in predicted documents.", +"format": "int32", +"type": "integer" +}, +"recall": { +"description": "The calculated recall.", +"format": "float", +"type": "number" +}, +"totalDocumentsCount": { +"description": "The amount of documents that had an occurrence of this label.", +"format": "int32", +"type": "integer" +}, +"truePositivesCount": { +"description": "The amount of true positives.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3EvaluationReference": { +"description": "Gives a short summary of an evaluation, and links to the evaluation itself.", +"id": "GoogleCloudDocumentaiV1beta3EvaluationReference", +"properties": { +"aggregateMetrics": { +"$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics", +"description": "An aggregate of the statistics for the evaluation with fuzzy matching on." +}, +"aggregateMetricsExact": { +"$ref": "GoogleCloudDocumentaiV1beta3EvaluationMetrics", +"description": "An aggregate of the statistics for the evaluation with fuzzy matching off." +}, +"evaluation": { +"description": "The resource name of the evaluation.", +"type": "string" +}, +"operation": { +"description": "The resource name of the Long Running Operation for the evaluation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3FieldExtractionMetadata": { +"description": "Metadata for how this field value is extracted.", +"id": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata", +"properties": { +"summaryOptions": { +"$ref": "GoogleCloudDocumentaiV1beta3SummaryOptions", +"description": "Summary options config." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3GcsPrefix": { +"description": "Specifies all documents on Cloud Storage with a common prefix.", +"id": "GoogleCloudDocumentaiV1beta3GcsPrefix", +"properties": { +"gcsUriPrefix": { +"description": "The URI prefix.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3HumanReviewStatus": { +"description": "The status of human review on a processed document.", +"id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", +"properties": { +"humanReviewOperation": { +"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", +"type": "string" +}, +"state": { +"description": "The state of human review on the processing request.", +"enum": [ +"STATE_UNSPECIFIED", +"SKIPPED", +"VALIDATION_PASSED", +"IN_PROGRESS", +"ERROR" +], +"enumDescriptions": [ +"Human review state is unspecified. Most likely due to an internal error.", +"Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", +"Human review validation is triggered and passed, so no review is needed.", +"Human review validation is triggered and the document is under review.", +"Some error happened during triggering human review, see the state_message for details." +], +"type": "string" +}, +"stateMessage": { +"description": "A message providing more details about the human review state.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { +"description": "Metadata of the import document operation.", +"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +}, +"importConfigValidationResults": { +"description": "Validation statuses of the batch documents import config.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" +}, +"type": "array" +}, +"individualImportStatuses": { +"description": "The list of response details of each document.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" +}, +"type": "array" +}, +"totalDocumentCount": { +"description": "Total number of the documents that are qualified for importing.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { +"description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", +"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", +"properties": { +"inputGcsSource": { +"description": "The source Cloud Storage URI specified in the import config.", +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The validation status of import config." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { +"description": "The status of each individual document in the import process.", +"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", +"properties": { +"inputGcsSource": { +"description": "The source Cloud Storage URI of the document.", +"type": "string" +}, +"outputDocumentId": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentId", +"description": "The document id of imported document if it was successful, otherwise empty." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the importing of the document." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { +"description": "Response of the import document operation.", +"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { +"description": "The long-running operation metadata for the ImportProcessorVersion method.", +"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", +"description": "The basic metadata for the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": { +"description": "The response message for the ImportProcessorVersion method.", +"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse", +"properties": { +"processorVersion": { +"description": "The destination processor version name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3Processor": { +"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", +"id": "GoogleCloudDocumentaiV1beta3Processor", +"properties": { +"activeSchemaVersion": { +"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", +"type": "string" +}, +"createTime": { +"description": "Output only. The time the processor was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultProcessorVersion": { +"description": "The default processor version.", +"type": "string" +}, +"displayName": { +"description": "The display name of the processor.", +"type": "string" +}, +"kmsKeyName": { +"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", +"type": "string" +}, +"name": { +"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", +"readOnly": true, +"type": "string" +}, +"processEndpoint": { +"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", +"readOnly": true, +"type": "string" +}, +"processorVersionAliases": { +"description": "Output only. The processor version aliases.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias" +}, +"readOnly": true, +"type": "array" +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the processor.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED", +"ENABLING", +"DISABLING", +"CREATING", +"FAILED", +"DELETING" +], +"enumDescriptions": [ +"The processor is in an unspecified state.", +"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", +"The processor is disabled.", +"The processor is being enabled, will become `ENABLED` if successful.", +"The processor is being disabled, will become `DISABLED` if successful.", +"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", +"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", +"The processor is being deleted, will be removed if successful." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse": { -"description": "Response of the EvaluateProcessorVersion method.", -"id": "GoogleCloudDocumentaiV1beta3EvaluateProcessorVersionResponse", +"GoogleCloudDocumentaiV1beta3ProcessorVersion": { +"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersion", "properties": { -"evaluation": { -"description": "The resource name of the created evaluation.", +"createTime": { +"description": "Output only. The time the processor version was created.", +"format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" +"deprecationInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo", +"description": "Output only. If set, information about the eventual deprecation of this version.", +"readOnly": true }, -"GoogleCloudDocumentaiV1beta3GcsPrefix": { -"description": "Specifies all documents on Cloud Storage with a common prefix.", -"id": "GoogleCloudDocumentaiV1beta3GcsPrefix", -"properties": { -"gcsUriPrefix": { -"description": "The URI prefix.", +"displayName": { +"description": "The display name of the processor version.", "type": "string" -} }, -"type": "object" +"documentSchema": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", +"description": "Output only. The schema of the processor version. Describes the output.", +"readOnly": true }, -"GoogleCloudDocumentaiV1beta3HumanReviewStatus": { -"description": "The status of human review on a processed document.", -"id": "GoogleCloudDocumentaiV1beta3HumanReviewStatus", -"properties": { -"humanReviewOperation": { -"description": "The name of the operation triggered by the processed document. This field is populated only when the state is `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as the long-running operation returned by ReviewDocument.", +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true +}, +"googleManaged": { +"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", +"readOnly": true, +"type": "boolean" +}, +"kmsKeyName": { +"description": "Output only. The KMS key name used for encryption.", +"readOnly": true, "type": "string" }, -"state": { -"description": "The state of human review on the processing request.", +"kmsKeyVersionName": { +"description": "Output only. The KMS key version with which data is encrypted.", +"readOnly": true, +"type": "string" +}, +"latestEvaluation": { +"$ref": "GoogleCloudDocumentaiV1beta3EvaluationReference", +"description": "Output only. The most recently invoked evaluation for the processor version.", +"readOnly": true +}, +"modelType": { +"description": "Output only. The model type of this processor version.", "enum": [ -"STATE_UNSPECIFIED", -"SKIPPED", -"VALIDATION_PASSED", -"IN_PROGRESS", -"ERROR" +"MODEL_TYPE_UNSPECIFIED", +"MODEL_TYPE_GENERATIVE", +"MODEL_TYPE_CUSTOM" ], "enumDescriptions": [ -"Human review state is unspecified. Most likely due to an internal error.", -"Human review is skipped for the document. This can happen because human review isn't enabled on the processor or the processing request has been set to skip this document.", -"Human review validation is triggered and passed, so no review is needed.", -"Human review validation is triggered and the document is under review.", -"Some error happened during triggering human review, see the state_message for details." +"The processor version has unspecified model type.", +"The processor version has generative model type.", +"The processor version has custom model type." ], +"readOnly": true, "type": "string" }, -"stateMessage": { -"description": "A message providing more details about the human review state.", +"name": { +"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", +"type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the processor version.", +"enum": [ +"STATE_UNSPECIFIED", +"DEPLOYED", +"DEPLOYING", +"UNDEPLOYED", +"UNDEPLOYING", +"CREATING", +"DELETING", +"FAILED", +"IMPORTING" +], +"enumDescriptions": [ +"The processor version is in an unspecified state.", +"The processor version is deployed and can be used for processing.", +"The processor version is being deployed.", +"The processor version is not deployed and cannot be used for processing.", +"The processor version is being undeployed.", +"The processor version is being created.", +"The processor version is being deleted.", +"The processor version failed and is in an indeterminate state.", +"The processor version is being imported." +], +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata": { -"description": "Metadata of the import document operation.", -"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadata", +"GoogleCloudDocumentaiV1beta3ProcessorVersionAlias": { +"description": "Contains the alias and the aliased resource name of processor version.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionAlias", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." -}, -"importConfigValidationResults": { -"description": "Validation statuses of the batch documents import config.", -"items": { -"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult" +"alias": { +"description": "The alias in the form of `processor_version` resource name.", +"type": "string" }, -"type": "array" +"processorVersion": { +"description": "The resource name of aliased processor version.", +"type": "string" +} }, -"individualImportStatuses": { -"description": "The list of response details of each document.", -"items": { -"$ref": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus" +"type": "object" }, -"type": "array" +"GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo": { +"description": "Information about the upcoming deprecation of this processor version.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionDeprecationInfo", +"properties": { +"deprecationTime": { +"description": "The time at which this processor version will be deprecated.", +"format": "google-datetime", +"type": "string" }, -"totalDocumentCount": { -"description": "Total number of the documents that are qualified for importing.", -"format": "int32", -"type": "integer" +"replacementProcessorVersion": { +"description": "If set, the processor version that will be used as a replacement.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult": { -"description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", -"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataImportConfigValidationResult", +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", "properties": { -"inputGcsSource": { -"description": "The source Cloud Storage URI specified in the import config.", -"type": "string" +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The validation status of import config." +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus": { -"description": "The status of each individual document in the import process.", -"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsMetadataIndividualImportStatus", +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", "properties": { -"inputGcsSource": { -"description": "The source Cloud Storage URI of the document.", +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", "type": "string" }, -"outputDocumentId": { -"$ref": "GoogleCloudDocumentaiV1beta3DocumentId", -"description": "The document id of imported document if it was successful, otherwise empty." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the importing of the document." +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3ImportDocumentsResponse": { -"description": "Response of the import document operation.", -"id": "GoogleCloudDocumentaiV1beta3ImportDocumentsResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata": { -"description": "The long-running operation metadata for the ImportProcessorVersion method.", -"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionMetadata", +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", -"description": "The basic metadata for the long-running operation." +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" +}, +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse": { -"description": "The response message for the ImportProcessorVersion method.", -"id": "GoogleCloudDocumentaiV1beta3ImportProcessorVersionResponse", +"GoogleCloudDocumentaiV1beta3PropertyMetadata": { +"description": "Metadata about a property.", +"id": "GoogleCloudDocumentaiV1beta3PropertyMetadata", "properties": { -"processorVersion": { -"description": "The destination processor version name.", -"type": "string" +"fieldExtractionMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3FieldExtractionMetadata", +"description": "Field extraction metadata on the property." +}, +"inactive": { +"description": "Whether the property should be considered as \"inactive\".", +"type": "boolean" } }, "type": "object" @@ -6250,6 +8241,43 @@ true "properties": {}, "type": "object" }, +"GoogleCloudDocumentaiV1beta3SummaryOptions": { +"description": "Metadata for document summarization.", +"id": "GoogleCloudDocumentaiV1beta3SummaryOptions", +"properties": { +"format": { +"description": "The format the summary should be in.", +"enum": [ +"FORMAT_UNSPECIFIED", +"PARAGRAPH", +"BULLETS" +], +"enumDescriptions": [ +"Default.", +"Format the output in paragraphs.", +"Format the output in bullets." +], +"type": "string" +}, +"length": { +"description": "How long the summary should be.", +"enum": [ +"LENGTH_UNSPECIFIED", +"BRIEF", +"MODERATE", +"COMPREHENSIVE" +], +"enumDescriptions": [ +"Default.", +"A brief summary of one or two sentences.", +"A paragraph-length summary.", +"The longest option available." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata": { "description": "The metadata that represents a processor version being created.", "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionMetadata", @@ -6338,6 +8366,17 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": { +"description": "The long-running operation metadata for the UpdateProcessorVersion method.", +"id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", +"description": "The basic metadata for the long-running operation." +} +}, +"type": "object" +}, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 66c5cca6f9..fa685fd2ea 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1289,13 +1289,352 @@ } } } +}, +"schemas": { +"methods": { +"create": { +"description": "Creates a schema.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas", +"httpMethod": "POST", +"id": "documentai.projects.locations.schemas.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project and location) under which to create the Schema. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+parent}/schemas", +"request": { +"$ref": "GoogleCloudDocumentaiV1beta3NextSchema" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3NextSchema" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a schema.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", +"httpMethod": "DELETE", +"id": "documentai.projects.locations.schemas.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to true, any child resources of this Schema will also be deleted. (Otherwise, the request will only work if the Schema has no child resources.)", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The name of the Schema to be deleted. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a schema.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Schema to get. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+name}", +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3NextSchema" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Schemas.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of schema groups to return. If unspecified, at most `10` Schema will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. We will return the schema groups sorted by creation time. The page token will point to the next Schema.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+parent}/schemas", +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3ListSchemasResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a schema. Editable fields are: - `display_name` - `labels`", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}", +"httpMethod": "PATCH", +"id": "documentai.projects.locations.schemas.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta3/{+name}", +"request": { +"$ref": "GoogleCloudDocumentaiV1beta3NextSchema" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3NextSchema" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"schemaVersions": { +"methods": { +"create": { +"description": "Creates a schema version.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", +"httpMethod": "POST", +"id": "documentai.projects.locations.schemas.schemaVersions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project and location) under which to create the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+parent}/schemaVersions", +"request": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a schema version.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", +"httpMethod": "DELETE", +"id": "documentai.projects.locations.schemas.schemaVersions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the SchemaVersion to delete. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generate": { +"description": "Generates a schema version.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions:generate", +"httpMethod": "POST", +"id": "documentai.projects.locations.schemas.schemaVersions.generate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project, location and schema) under which to generate the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+parent}/schemaVersions:generate", +"request": { +"$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a schema version.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.schemaVersions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the SchemaVersion to get. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+name}", +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists SchemaVersions.", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions", +"httpMethod": "GET", +"id": "documentai.projects.locations.schemas.schemaVersions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of SchemaVersion to return. If unspecified, at most `10` SchemaVersion will be returned. The maximum value is `20`. Values above `20` will be coerced to `20`.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. We will return the SchemaVersion sorted by creation time. The page token will point to the next SchemaVersion.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta3/{+parent}/schemaVersions", +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a schema version. Editable fields are: - `display_name` - `labels`", +"flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/schemas/{schemasId}/schemaVersions/{schemaVersionsId}", +"httpMethod": "PATCH", +"id": "documentai.projects.locations.schemas.schemaVersions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/schemas/[^/]+/schemaVersions/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. The update mask to apply to the resource. **Note:** Only the following fields can be updated: - display_name. - labels.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta3/{+name}", +"request": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" +}, +"response": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } } } } }, -"revision": "20251013", +"revision": "20251020", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": { @@ -1920,7 +2259,170 @@ }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { +"GoogleCloudDocumentaiUiv1beta3DocumentSchema": { +"description": "The schema defines the output of the processed document by a processor.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", +"properties": { +"description": { +"description": "Description of the schema.", +"type": "string" +}, +"displayName": { +"description": "Display name to show to users.", +"type": "string" +}, +"entityTypes": { +"description": "Entity types of the schema.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType" +}, +"type": "array" +}, +"metadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", +"description": "Metadata of the schema." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType": { +"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityType", +"properties": { +"baseTypes": { +"description": "The entity type that this type is derived from. For now, one and only one should be set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", +"type": "string" +}, +"displayName": { +"description": "User defined name for the type.", +"type": "string" +}, +"entityTypeMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", +"description": "Metadata for the entity type." +}, +"enumValues": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", +"description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file." +}, +"name": { +"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility internal infrastructure and tooling can handle any ascii character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.", +"type": "string" +}, +"properties": { +"description": "Description the nested structure, or composition of an entity.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues": { +"description": "Defines the a list of enum values.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeEnumValues", +"properties": { +"values": { +"description": "The individual values that this enum values type can include.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty": { +"description": "Defines properties that can be part of the entity type.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaEntityTypeProperty", +"properties": { +"description": { +"description": "The description of the property. Could be used to provide more information about the property for model calls.", +"type": "string" +}, +"displayName": { +"description": "User defined name for the property.", +"type": "string" +}, +"method": { +"description": "Specifies how the entity's value is obtained.", +"enum": [ +"METHOD_UNSPECIFIED", +"EXTRACT", +"DERIVE" +], +"enumDescriptions": [ +"Unspecified method. It defaults to `EXTRACT`.", +"The entity's value is directly extracted as-is from the document text.", +"The entity's value is derived through inference and is not necessarily an exact text extraction from the document." +], +"type": "string" +}, +"name": { +"description": "The name of the property. Follows the same guidelines as the EntityType name.", +"type": "string" +}, +"occurrenceType": { +"description": "Occurrence type limits the number of instances an entity type appears in the document.", +"enum": [ +"OCCURRENCE_TYPE_UNSPECIFIED", +"OPTIONAL_ONCE", +"OPTIONAL_MULTIPLE", +"REQUIRED_ONCE", +"REQUIRED_MULTIPLE" +], +"enumDescriptions": [ +"Unspecified occurrence type.", +"There will be zero or one instance of this entity type. The same entity instance may be mentioned multiple times.", +"The entity type will appear zero or multiple times.", +"The entity type will only appear exactly once. The same entity instance may be mentioned multiple times.", +"The entity type will appear once or more times." +], +"type": "string" +}, +"propertyMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", +"description": "Any additional metadata about the property can be added here." +}, +"valueType": { +"description": "A reference to the value type of the property. This type is subject to the same conventions as the `Entity.base_types` field.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata": { +"description": "Metadata for global schema behavior.", +"id": "GoogleCloudDocumentaiUiv1beta3DocumentSchemaMetadata", +"properties": { +"documentAllowMultipleLabels": { +"description": "If true, on a given page, there can be multiple `document` annotations covering it.", +"type": "boolean" +}, +"documentSplitter": { +"description": "If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).", +"type": "boolean" +}, +"prefixedNamingOnProperties": { +"description": "If set, all the nested entities must be prefixed with the parents.", +"type": "boolean" +}, +"skipNamingValidation": { +"description": "If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata": { "description": "The long-running operation metadata for the EnableProcessor method.", "id": "GoogleCloudDocumentaiUiv1beta3EnableProcessorMetadata", "properties": { @@ -1937,6 +2439,37 @@ "properties": {}, "type": "object" }, +"GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata": { +"description": "Metadata about an entity type.", +"id": "GoogleCloudDocumentaiUiv1beta3EntityTypeMetadata", +"properties": { +"fieldTierMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", +"description": "Field tier metadata on the property" +}, +"humanReviewLabelingMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", +"description": "Human review labeling config on the entity." +}, +"humanReviewMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", +"description": "Human review config on the entity." +}, +"inactive": { +"description": "Whether the entity type should be considered inactive.", +"type": "boolean" +}, +"schemaEditabilityMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", +"description": "Schema editability metadata on the entity." +}, +"schemaInferenceMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", +"description": "Schema inference metadata on the entity." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata": { "description": "Metadata of the EvaluateProcessorVersion method.", "id": "GoogleCloudDocumentaiUiv1beta3EvaluateProcessorVersionMetadata", @@ -1959,6 +2492,91 @@ }, "type": "object" }, +"GoogleCloudDocumentaiUiv1beta3EvaluationMetrics": { +"description": "Evaluation metrics, either in aggregate or about a specific entity.", +"id": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", +"properties": { +"f1Score": { +"description": "The calculated f1 score.", +"format": "float", +"type": "number" +}, +"falseNegativesCount": { +"description": "The amount of false negatives.", +"format": "int32", +"type": "integer" +}, +"falsePositivesCount": { +"description": "The amount of false positives.", +"format": "int32", +"type": "integer" +}, +"groundTruthDocumentCount": { +"description": "The amount of documents with a ground truth occurrence.", +"format": "int32", +"type": "integer" +}, +"groundTruthOccurrencesCount": { +"description": "The amount of occurrences in ground truth documents.", +"format": "int32", +"type": "integer" +}, +"precision": { +"description": "The calculated precision.", +"format": "float", +"type": "number" +}, +"predictedDocumentCount": { +"description": "The amount of documents with a predicted occurrence.", +"format": "int32", +"type": "integer" +}, +"predictedOccurrencesCount": { +"description": "The amount of occurrences in predicted documents.", +"format": "int32", +"type": "integer" +}, +"recall": { +"description": "The calculated recall.", +"format": "float", +"type": "number" +}, +"totalDocumentsCount": { +"description": "The amount of documents that had an occurrence of this label.", +"format": "int32", +"type": "integer" +}, +"truePositivesCount": { +"description": "The amount of true positives.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3EvaluationReference": { +"description": "Gives a short summary of an evaluation, and links to the evaluation itself.", +"id": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", +"properties": { +"aggregateMetrics": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", +"description": "An aggregate of the statistics for the evaluation with fuzzy matching on." +}, +"aggregateMetricsExact": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationMetrics", +"description": "An aggregate of the statistics for the evaluation with fuzzy matching off." +}, +"evaluation": { +"description": "The resource name of the evaluation.", +"type": "string" +}, +"operation": { +"description": "The resource name of the Long Running Operation for the evaluation.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata": { "description": "Metadata of the batch export documents operation.", "id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsMetadata", @@ -2031,126 +2649,516 @@ }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse": { -"description": "The response proto of ExportDocuments method.", -"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata": { -"description": "Metadata message associated with the ExportProcessorVersion operation.", -"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata", +"GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse": { +"description": "The response proto of ExportDocuments method.", +"id": "GoogleCloudDocumentaiUiv1beta3ExportDocumentsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata": { +"description": "Metadata message associated with the ExportProcessorVersion operation.", +"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The common metadata about the operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": { +"description": "Response message associated with the ExportProcessorVersion operation.", +"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse", +"properties": { +"gcsUri": { +"description": "The Cloud Storage URI containing the output artifacts.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata": { +"description": "Metadata for how this field value is extracted.", +"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", +"properties": { +"entityQuery": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", +"description": "Entity query config." +}, +"summaryOptions": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", +"description": "Summary options config." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery": { +"description": "Message for entity query.", +"id": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadataEntityQuery", +"properties": { +"userEntityQuery": { +"description": "The original entity query inputed by the user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3FieldTierMetadata": { +"description": "Metadata for the field tier of a property.", +"id": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", +"properties": { +"tierLevel": { +"description": "Integer that indicates the tier of a property. e.g. Invoice has entities that are classified as tier 1 which is the most important, while tier 2 and tier 3 less so. This attribute can be used to filter schema attributes before running eval. e.g. compute F1 score for only tier 1 entities. If not present this attribute should be inferred as 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata": { +"description": "Metadata for human review labeling config.", +"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", +"properties": { +"enableNormalizationEditing": { +"description": "Whether to enable normalization editing.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata": { +"description": "Metadata for Human Review config.", +"id": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", +"properties": { +"confidenceThreshold": { +"description": "The confidence threshold if human review validation is enabled.", +"format": "float", +"type": "number" +}, +"enableValidation": { +"description": "Whether to enable human review validation.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { +"description": "Metadata of the import document operation.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +}, +"importConfigValidationResults": { +"description": "Validation statuses of the batch documents import config.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" +}, +"type": "array" +}, +"individualImportStatuses": { +"description": "The list of response details of each document.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" +}, +"type": "array" +}, +"totalDocumentCount": { +"description": "Total number of the documents that are qualified for importing.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { +"description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", +"properties": { +"inputGcsSource": { +"description": "The source Cloud Storage URI specified in the import config.", +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The validation status of import config." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { +"description": "The status of each individual document in the import process.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", +"properties": { +"inputGcsSource": { +"description": "The source Cloud Storage URI of the document.", +"type": "string" +}, +"outputDocumentId": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", +"description": "The document id of imported document if it was successful, otherwise empty." +}, +"outputGcsDestination": { +"description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the importing of the document." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": { +"description": "Response of the import document operation.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { +"description": "The long-running operation metadata for the ImportProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata for the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": { +"description": "The response message for the ImportProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse", +"properties": { +"processorVersion": { +"description": "The destination processor version name.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3Processor": { +"description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", +"id": "GoogleCloudDocumentaiUiv1beta3Processor", +"properties": { +"activeSchemaVersion": { +"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", +"type": "string" +}, +"createTime": { +"description": "Output only. The time the processor was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultProcessorVersion": { +"description": "The default processor version.", +"type": "string" +}, +"displayName": { +"description": "The display name of the processor.", +"type": "string" +}, +"kmsKeyName": { +"description": "The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios.", +"type": "string" +}, +"name": { +"description": "Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}`", +"readOnly": true, +"type": "string" +}, +"processEndpoint": { +"description": "Output only. Immutable. The http endpoint that can be called to invoke processing.", +"readOnly": true, +"type": "string" +}, +"processorVersionAliases": { +"description": "Output only. The processor version aliases.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias" +}, +"readOnly": true, +"type": "array" +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the processor.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED", +"ENABLING", +"DISABLING", +"CREATING", +"FAILED", +"DELETING" +], +"enumDescriptions": [ +"The processor is in an unspecified state.", +"The processor is enabled, i.e., has an enabled version which can currently serve processing requests and all the feature dependencies have been successfully initialized.", +"The processor is disabled.", +"The processor is being enabled, will become `ENABLED` if successful.", +"The processor is being disabled, will become `DISABLED` if successful.", +"The processor is being created, will become either `ENABLED` (for successful creation) or `FAILED` (for failed ones). Once a processor is in this state, it can then be used for document processing, but the feature dependencies of the processor might not be fully created yet.", +"The processor failed during creation or initialization of feature dependencies. The user should delete the processor and recreate one as all the functionalities of the processor are disabled.", +"The processor is being deleted, will be removed if successful." +], +"readOnly": true, +"type": "string" +}, +"type": { +"description": "The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ProcessorVersion": { +"description": "A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time. Its document-processing behavior is defined by that version.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersion", +"properties": { +"createTime": { +"description": "Output only. The time the processor version was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"deploymentAllowed": { +"description": "Output only. Denotes that this `ProcessorVersion` can be deployed and undeployed.", +"readOnly": true, +"type": "boolean" +}, +"deprecationInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", +"description": "Output only. If set, information about the eventual deprecation of this version.", +"readOnly": true +}, +"displayName": { +"description": "The display name of the processor version.", +"type": "string" +}, +"documentSchema": { +"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentSchema", +"description": "Output only. The schema of the processor version. Describes the output.", +"readOnly": true +}, +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true +}, +"googleManaged": { +"description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", +"readOnly": true, +"type": "boolean" +}, +"kmsKeyName": { +"description": "Output only. The KMS key name used for encryption.", +"readOnly": true, +"type": "string" +}, +"kmsKeyVersionName": { +"description": "Output only. The KMS key version with which data is encrypted.", +"readOnly": true, +"type": "string" +}, +"latestEvaluation": { +"$ref": "GoogleCloudDocumentaiUiv1beta3EvaluationReference", +"description": "Output only. The most recently invoked evaluation for the processor version.", +"readOnly": true +}, +"modelType": { +"description": "Output only. The model type of this processor version.", +"enum": [ +"MODEL_TYPE_UNSPECIFIED", +"MODEL_TYPE_GENERATIVE", +"MODEL_TYPE_CUSTOM" +], +"enumDescriptions": [ +"The processor version has unspecified model type.", +"The processor version has generative model type.", +"The processor version has custom model type." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}`", +"type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"schema": { +"$ref": "GoogleCloudDocumentaiUiv1beta3Schema", +"description": "The schema of the processor version. Describes the output." +}, +"state": { +"description": "Output only. The state of the processor version.", +"enum": [ +"STATE_UNSPECIFIED", +"DEPLOYED", +"DEPLOYING", +"UNDEPLOYED", +"UNDEPLOYING", +"CREATING", +"DELETING", +"FAILED", +"IMPORTING" +], +"enumDescriptions": [ +"The processor version is in an unspecified state.", +"The processor version is deployed and can be used for processing.", +"The processor version is being deployed.", +"The processor version is not deployed and cannot be used for processing.", +"The processor version is being undeployed.", +"The processor version is being created.", +"The processor version is being deleted.", +"The processor version failed and is in an indeterminate state.", +"The processor version is being imported." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias": { +"description": "Contains the alias and the aliased resource name of processor version.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionAlias", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The common metadata about the operation." -} -}, -"type": "object" +"alias": { +"description": "The alias in the form of `processor_version` resource name.", +"type": "string" }, -"GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse": { -"description": "Response message associated with the ExportProcessorVersion operation.", -"id": "GoogleCloudDocumentaiUiv1beta3ExportProcessorVersionResponse", -"properties": { -"gcsUri": { -"description": "The Cloud Storage URI containing the output artifacts.", +"processorVersion": { +"description": "The resource name of aliased processor version.", "type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata": { -"description": "Metadata of the import document operation.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadata", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo": { +"description": "Information about the upcoming deprecation of this processor version.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionDeprecationInfo", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." -}, -"importConfigValidationResults": { -"description": "Validation statuses of the batch documents import config.", -"items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult" -}, -"type": "array" -}, -"individualImportStatuses": { -"description": "The list of response details of each document.", -"items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus" -}, -"type": "array" +"deprecationTime": { +"description": "The time at which this processor version will be deprecated.", +"format": "google-datetime", +"type": "string" }, -"totalDocumentCount": { -"description": "Total number of the documents that are qualified for importing.", -"format": "int32", -"type": "integer" +"replacementProcessorVersion": { +"description": "If set, the processor version that will be used as a replacement.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult": { -"description": "The validation status of each import config. Status is set to an error if there are no documents to import in the `import_config`, or `OK` if the operation will try to proceed with at least one document.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataImportConfigValidationResult", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfo", "properties": { -"inputGcsSource": { -"description": "The source Cloud Storage URI specified in the import config.", -"type": "string" +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The validation status of import config." +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus": { -"description": "The status of each individual document in the import process.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsMetadataIndividualImportStatus", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", "properties": { -"inputGcsSource": { -"description": "The source Cloud Storage URI of the document.", +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", "type": "string" }, -"outputDocumentId": { -"$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId", -"description": "The document id of imported document if it was successful, otherwise empty." -}, -"outputGcsDestination": { -"description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.", +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], "type": "string" -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the importing of the document." } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse": { -"description": "Response of the import document operation.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportDocumentsResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata": { -"description": "The long-running operation metadata for the ImportProcessorVersion method.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionMetadata", +"GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiUiv1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", "properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata for the long-running operation." +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" +}, +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse": { -"description": "The response message for the ImportProcessorVersion method.", -"id": "GoogleCloudDocumentaiUiv1beta3ImportProcessorVersionResponse", +"GoogleCloudDocumentaiUiv1beta3PropertyMetadata": { +"description": "Metadata about a property.", +"id": "GoogleCloudDocumentaiUiv1beta3PropertyMetadata", "properties": { -"processorVersion": { -"description": "The destination processor version name.", -"type": "string" +"fieldExtractionMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldExtractionMetadata", +"description": "Field extraction metadata on the property." +}, +"fieldTierMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3FieldTierMetadata", +"description": "Field tier metadata on the property" +}, +"humanReviewLabelingMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewLabelingMetadata", +"description": "Human review labeling config on the property." +}, +"humanReviewMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3HumanReviewValidationMetadata", +"description": "Human review validation config on the property." +}, +"inactive": { +"description": "Whether the property should be considered as \"inactive\".", +"type": "boolean" +}, +"schemaEditabilityMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", +"description": "Schema editability metadata on the property." +}, +"schemaInferenceMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", +"description": "Schema inference metadata on the property." } }, "type": "object" @@ -2257,59 +3265,192 @@ "BASE_OCR_REVISION" ], "enumDescriptions": [ -"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", -"The latest revision made by a human.", -"The latest revision based on timestamp.", -"The first (OCR) revision." +"Unspecified case, fall back to read the `LATEST_HUMAN_REVIEW`.", +"The latest revision made by a human.", +"The latest revision based on timestamp.", +"The first (OCR) revision." +], +"type": "string" +}, +"revisionId": { +"description": "Reads the revision given by the id.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { +"description": "Metadata of the sample documents operation.", +"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata of the long-running operation." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { +"description": "Response of the sample documents operation.", +"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", +"properties": { +"sampleTestStatus": { +"$ref": "GoogleRpcStatus", +"description": "The status of sampling documents in test split." +}, +"sampleTrainingStatus": { +"$ref": "GoogleRpcStatus", +"description": "The status of sampling documents in training split." +}, +"selectedDocuments": { +"description": "The result of the sampling process.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { +"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", +"properties": { +"documentId": { +"description": "An internal identifier for document.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3Schema": { +"description": "The schema defines the output of the processed document by a processor.", +"id": "GoogleCloudDocumentaiUiv1beta3Schema", +"properties": { +"description": { +"description": "Description of the schema.", +"type": "string" +}, +"displayName": { +"description": "Display name to show to users.", +"type": "string" +}, +"entityTypes": { +"description": "Entity types of the schema.", +"items": { +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata": { +"description": "Metadata that specifies whether a label is editable and reasons why. These fields are read-only. Changing these fields has no impact on the backend.", +"id": "GoogleCloudDocumentaiUiv1beta3SchemaEditabilityMetadata", +"properties": { +"editable": { +"description": "Explicit flag that controls whether the label is editable.", +"type": "boolean" +}, +"processorVersions": { +"description": "Full resource name of processor versions that contain this label. e.g. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiUiv1beta3SchemaEntityType": { +"description": "EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types.", +"id": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType", +"properties": { +"baseType": { +"type": "string" +}, +"description": { +"description": "Description of the entity type.", +"type": "string" +}, +"enumValues": { +"description": "If specified, lists all the possible values for this entity.", +"items": { +"type": "string" +}, +"type": "array" +}, +"hide": { +"description": "If the entity type is hidden in the schema. This provides the functionality to temporally \"disable\" an entity without deleting it.", +"type": "boolean" +}, +"method": { +"description": "Specifies how the entity's value is obtained.", +"enum": [ +"METHOD_UNSPECIFIED", +"EXTRACT", +"DERIVE" +], +"enumDescriptions": [ +"Unspecified method. It defaults to `EXTRACT`.", +"The entity's value is directly extracted as-is from the document text.", +"The entity's value is derived through inference and is not necessarily an exact text extraction from the document." ], "type": "string" }, -"revisionId": { -"description": "Reads the revision given by the id.", +"occurrenceType": { +"description": "Occurrence type limits the number of times an entity type appears in the document.", +"enum": [ +"OCCURRENCE_TYPE_UNSPECIFIED", +"OPTIONAL_ONCE", +"OPTIONAL_MULTIPLE", +"REQUIRED_ONCE", +"REQUIRED_MULTIPLE" +], +"enumDescriptions": [ +"Unspecified occurrence type.", +"The entity type will appear zero times or once.", +"The entity type will appear zero or multiple times.", +"The entity type will only appear exactly once.", +"The entity type will appear once or more times." +], "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata": { -"description": "Metadata of the sample documents operation.", -"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsMetadata", -"properties": { -"commonMetadata": { -"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", -"description": "The basic metadata of the long-running operation." -} -}, -"type": "object" }, -"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse": { -"description": "Response of the sample documents operation.", -"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponse", "properties": { -"sampleTestStatus": { -"$ref": "GoogleRpcStatus", -"description": "The status of sampling documents in test split." -}, -"sampleTrainingStatus": { -"$ref": "GoogleRpcStatus", -"description": "The status of sampling documents in training split." -}, -"selectedDocuments": { -"description": "The result of the sampling process.", +"description": "Describing the nested structure of an entity. An EntityType may consist of several other EntityTypes. For example, in a document there can be an EntityType `ID`, which consists of EntityType `name` and `address`, with corresponding attributes, such as TEXT for both types and ONCE for occurrence types.", "items": { -"$ref": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument" +"$ref": "GoogleCloudDocumentaiUiv1beta3SchemaEntityType" }, "type": "array" +}, +"source": { +"description": "Source of this entity type.", +"enum": [ +"SOURCE_UNSPECIFIED", +"PREDEFINED", +"USER_INPUT" +], +"enumDescriptions": [ +"Unspecified source.", +"The entity type is in the predefined schema of a pretrained version of a processor.", +"The entity type is added by the users either: - during an uptraining of an existing processor, or - during the process of creating a customized processor." +], +"type": "string" +}, +"type": { +"description": "Name of the type. It must satisfy the following constraints: 1. Must be unique within the set of same level types (with case-insensitive match). 2. Maximum 64 characters. 3. Must start with a letter. 4. Allowed characters: ASCII letters [a-zA-Z], ASCII digits [0-9], or one of the following punctuation characters: * underscore '_' (recommended) * hyphen '-' (allowed, not recommended) * colon ':' (allowed, not recommended) NOTE: Whitespace characters are not allowed. 5. Cannot end with a punctuation character. 6. Cannot contain the following restricted strings: \"google\", \"DocumentAI\" (case-insensitive match). 7. A slash character '/' is reserved as a separator in flattened representations of nested entity types (e.g., \"line_item/amount\") in which case each part (e.g., \"line_item\", \"amount\") must comply with the rules defined above. We recommend using the snake case (\"snake_case\") in entity type names.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument": { -"id": "GoogleCloudDocumentaiUiv1beta3SampleDocumentsResponseSelectedDocument", +"GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata": { +"description": "Metadata for schema inference. Only used on dataset.schema for schema inference, can be safely ignored elsewhere.", +"id": "GoogleCloudDocumentaiUiv1beta3SchemaInferenceMetadata", "properties": { -"documentId": { -"description": "An internal identifier for document.", -"type": "string" +"inferred": { +"description": "True if is inferred by schema inference.", +"type": "boolean" } }, "type": "object" @@ -2331,6 +3472,43 @@ "properties": {}, "type": "object" }, +"GoogleCloudDocumentaiUiv1beta3SummaryOptions": { +"description": "Metadata for document summarization.", +"id": "GoogleCloudDocumentaiUiv1beta3SummaryOptions", +"properties": { +"format": { +"description": "The format the summary should be in.", +"enum": [ +"FORMAT_UNSPECIFIED", +"PARAGRAPH", +"BULLETS" +], +"enumDescriptions": [ +"Default.", +"Format the output in paragraphs.", +"Format the output in bullets." +], +"type": "string" +}, +"length": { +"description": "How long the summary should be.", +"enum": [ +"LENGTH_UNSPECIFIED", +"BRIEF", +"MODERATE", +"COMPREHENSIVE" +], +"enumDescriptions": [ +"Default.", +"A brief summary of one or two sentences.", +"A paragraph-length summary.", +"The longest option available." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata": { "description": "The metadata that represents a processor version being created.", "id": "GoogleCloudDocumentaiUiv1beta3TrainProcessorVersionMetadata", @@ -2441,6 +3619,17 @@ }, "type": "object" }, +"GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata": { +"description": "The long-running operation metadata for the UpdateProcessorVersion method.", +"id": "GoogleCloudDocumentaiUiv1beta3UpdateProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiUiv1beta3CommonOperationMetadata", +"description": "The basic metadata for the long-running operation." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1BatchProcessMetadata": { "description": "The long-running operation metadata for BatchProcessDocuments.", "id": "GoogleCloudDocumentaiV1BatchProcessMetadata", @@ -4057,12 +5246,16 @@ "description": "Validation result for a single validation rule.", "id": "GoogleCloudDocumentaiV1beta3DocumentEntityValidationOutputValidationResult", "properties": { +"rule": { +"description": "Optional. The name of the rule resource that is used for validation. Format: `projects/{project}/locations/{location}/rules/{rule}`", +"type": "string" +}, "ruleDescription": { "description": "The description of the validation rule.", "type": "string" }, "ruleName": { -"description": "The name of the validation rule.", +"description": "The display name of the validation rule.", "type": "string" }, "validationDetails": { @@ -5386,6 +6579,20 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3Documents": { +"description": "A set of inline documents.", +"id": "GoogleCloudDocumentaiV1beta3Documents", +"properties": { +"documents": { +"description": "The list of documents.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3Document" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata": { "description": "The long-running operation metadata for the EnableProcessor method.", "id": "GoogleCloudDocumentaiV1beta3EnableProcessorMetadata", @@ -5738,6 +6945,63 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest": { +"description": "Request message for GenerateSchemaVersion.", +"id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequest", +"properties": { +"baseSchemaVersion": { +"description": "The base schema version name to use for the schema generation. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"type": "string" +}, +"gcsDocuments": { +"$ref": "GoogleCloudDocumentaiV1beta3GcsDocuments", +"description": "The set of documents placed on Cloud Storage." +}, +"gcsPrefix": { +"$ref": "GoogleCloudDocumentaiV1beta3GcsPrefix", +"description": "The common prefix of documents placed on Cloud Storage." +}, +"generateSchemaVersionParams": { +"$ref": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams", +"description": "Optional. User specified parameters for the schema generation." +}, +"inlineDocuments": { +"$ref": "GoogleCloudDocumentaiV1beta3Documents", +"description": "The set of documents specified inline." +}, +"rawDocuments": { +"$ref": "GoogleCloudDocumentaiV1beta3RawDocuments", +"description": "The set of raw documents." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams": { +"description": "The parameters for the schema generation.", +"id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionRequestGenerateSchemaVersionParams", +"properties": { +"history": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory", +"description": "Optional. Previous prompt-answers in a chronological order." +}, +"prompt": { +"description": "Optional. The prompt used for the schema generation.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse": { +"description": "Response message for GenerateSchemaVersion.", +"id": "GoogleCloudDocumentaiV1beta3GenerateSchemaVersionResponse", +"properties": { +"schemaVersion": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion", +"description": "The schema version generated by the model." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3GetDocumentResponse": { "id": "GoogleCloudDocumentaiV1beta3GetDocumentResponse", "properties": { @@ -6080,6 +7344,76 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse": { +"description": "Response message for ListSchemaVersions.", +"id": "GoogleCloudDocumentaiV1beta3ListSchemaVersionsResponse", +"properties": { +"nextPageToken": { +"description": "Points to the next SchemaVersion, otherwise empty.", +"type": "string" +}, +"schemaVersions": { +"description": "The list of SchemaVersions.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ListSchemasResponse": { +"description": "Response message for ListSchemas.", +"id": "GoogleCloudDocumentaiV1beta3ListSchemasResponse", +"properties": { +"nextPageToken": { +"description": "Points to the next Schema, otherwise empty.", +"type": "string" +}, +"schemas": { +"description": "The list of Schemas.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3NextSchema" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3NextSchema": { +"description": "NextSchema is a collection of SchemaVersions.", +"id": "GoogleCloudDocumentaiV1beta3NextSchema", +"properties": { +"createTime": { +"description": "Output only. The time when the Schema was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The user-defined name of the Schema.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The GCP labels for the Schema.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the Schema. Format: `projects/{project}/locations/{location}/schemas/{schema}`", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the Schema was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3NormalizedVertex": { "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", "id": "GoogleCloudDocumentaiV1beta3NormalizedVertex", @@ -6353,6 +7687,10 @@ true "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.", "id": "GoogleCloudDocumentaiV1beta3Processor", "properties": { +"activeSchemaVersion": { +"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}", +"type": "string" +}, "createTime": { "description": "Output only. The time the processor was created.", "format": "google-datetime", @@ -6733,6 +8071,20 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3RawDocuments": { +"description": "Specifies a set of raw documents.", +"id": "GoogleCloudDocumentaiV1beta3RawDocuments", +"properties": { +"documents": { +"description": "Specifies raw document content and mime type.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3RawDocument" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata": { "description": "The long-running operation metadata for the ReviewDocument method.", "id": "GoogleCloudDocumentaiV1beta3ReviewDocumentOperationMetadata", @@ -6878,6 +8230,71 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3SchemaGenerationHistory": { +"description": "The history of schema generation iterations.", +"id": "GoogleCloudDocumentaiV1beta3SchemaGenerationHistory", +"properties": { +"iterations": { +"description": "Required. Previous prompt-answers in a chronological order.", +"items": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3SchemaGenerationIteration": { +"description": "A single iteration of the schema generation.", +"id": "GoogleCloudDocumentaiV1beta3SchemaGenerationIteration", +"properties": { +"adjustedSchema": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion", +"description": "Optional. The previous schema version adjusted by the model." +}, +"generatedSchema": { +"$ref": "GoogleCloudDocumentaiV1beta3SchemaVersion", +"description": "Required. The schema version generated by the model." +}, +"prompt": { +"description": "Optional. The prompt used for the iteration.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3SchemaVersion": { +"description": "SchemaVersion is a version of the Schema which is created in SchemaGroup.", +"id": "GoogleCloudDocumentaiV1beta3SchemaVersion", +"properties": { +"createTime": { +"description": "Output only. The time when the SchemaVersion was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Optional. The user-defined name of the SchemaVersion.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The GCP labels for the SchemaVersion.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the SchemaVersion. Format: `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}`", +"type": "string" +}, +"schema": { +"$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", +"description": "Required. The schema of the SchemaVersion." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata": { "description": "The long-running operation metadata for the SetDefaultProcessorVersion method.", "id": "GoogleCloudDocumentaiV1beta3SetDefaultProcessorVersionMetadata", @@ -7121,6 +8538,17 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata": { +"description": "The long-running operation metadata for the UpdateProcessorVersion method.", +"id": "GoogleCloudDocumentaiV1beta3UpdateProcessorVersionMetadata", +"properties": { +"commonMetadata": { +"$ref": "GoogleCloudDocumentaiV1beta3CommonOperationMetadata", +"description": "The basic metadata for the long-running operation." +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3Vertex": { "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", "id": "GoogleCloudDocumentaiV1beta3Vertex", From d0d23365f047c5bc095d500fbfb6364fea5b829f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 35/70] feat(drive): update the api #### drive:v3 The following keys were added: - schemas.Comment.properties.assigneeEmailAddress (Total Keys: 2) - schemas.Comment.properties.mentionedEmailAddresses (Total Keys: 3) - schemas.Reply.properties.assigneeEmailAddress (Total Keys: 2) - schemas.Reply.properties.mentionedEmailAddresses (Total Keys: 3) --- docs/dyn/drive_v3.comments.html | 48 +++++++++++++++++++ docs/dyn/drive_v3.replies.html | 24 ++++++++++ .../discovery_cache/documents/drive.v3.json | 28 ++++++++++- 3 files changed, 99 insertions(+), 1 deletion(-) diff --git a/docs/dyn/drive_v3.comments.html b/docs/dyn/drive_v3.comments.html index d9a7d02d07..6df5e2a291 100644 --- a/docs/dyn/drive_v3.comments.html +++ b/docs/dyn/drive_v3.comments.html @@ -112,6 +112,7 @@

Method Details

{ # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -126,6 +127,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the comment with HTML formatting. "id": "A String", # Output only. The ID of the comment. "kind": "drive#comment", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time). "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. "mimeType": "A String", # The MIME type of the quoted content. @@ -134,6 +138,7 @@

Method Details

"replies": [ # Output only. The full list of replies to the comment in chronological order. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -148,6 +153,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], @@ -164,6 +172,7 @@

Method Details

{ # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -178,6 +187,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the comment with HTML formatting. "id": "A String", # Output only. The ID of the comment. "kind": "drive#comment", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time). "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. "mimeType": "A String", # The MIME type of the quoted content. @@ -186,6 +198,7 @@

Method Details

"replies": [ # Output only. The full list of replies to the comment in chronological order. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -200,6 +213,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], @@ -239,6 +255,7 @@

Method Details

{ # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -253,6 +270,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the comment with HTML formatting. "id": "A String", # Output only. The ID of the comment. "kind": "drive#comment", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time). "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. "mimeType": "A String", # The MIME type of the quoted content. @@ -261,6 +281,7 @@

Method Details

"replies": [ # Output only. The full list of replies to the comment in chronological order. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -275,6 +296,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], @@ -304,6 +328,7 @@

Method Details

"comments": [ # The list of comments. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -318,6 +343,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the comment with HTML formatting. "id": "A String", # Output only. The ID of the comment. "kind": "drive#comment", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time). "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. "mimeType": "A String", # The MIME type of the quoted content. @@ -326,6 +354,7 @@

Method Details

"replies": [ # Output only. The full list of replies to the comment in chronological order. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -340,6 +369,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], @@ -377,6 +409,7 @@

Method Details

{ # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -391,6 +424,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the comment with HTML formatting. "id": "A String", # Output only. The ID of the comment. "kind": "drive#comment", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time). "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. "mimeType": "A String", # The MIME type of the quoted content. @@ -399,6 +435,7 @@

Method Details

"replies": [ # Output only. The full list of replies to the comment in chronological order. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -413,6 +450,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], @@ -429,6 +469,7 @@

Method Details

{ # A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file. "anchor": "A String", # A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments). + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the comment. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -443,6 +484,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the comment with HTML formatting. "id": "A String", # Output only. The ID of the comment. "kind": "drive#comment", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the comment or any of its replies was modified (RFC 3339 date-time). "quotedFileContent": { # The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment. "mimeType": "A String", # The MIME type of the quoted content. @@ -451,6 +495,7 @@

Method Details

"replies": [ # Output only. The full list of replies to the comment in chronological order. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -465,6 +510,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], diff --git a/docs/dyn/drive_v3.replies.html b/docs/dyn/drive_v3.replies.html index 4a1a0c2e94..d7e0e150f6 100644 --- a/docs/dyn/drive_v3.replies.html +++ b/docs/dyn/drive_v3.replies.html @@ -113,6 +113,7 @@

Method Details

{ # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -127,6 +128,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). } @@ -140,6 +144,7 @@

Method Details

{ # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -154,6 +159,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }
@@ -192,6 +200,7 @@

Method Details

{ # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -206,6 +215,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). } @@ -234,6 +246,7 @@

Method Details

"replies": [ # The list of replies. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. { # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -248,6 +261,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). }, ], @@ -281,6 +297,7 @@

Method Details

{ # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -295,6 +312,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). } @@ -308,6 +328,7 @@

Method Details

{ # A reply to a comment on a file. Some resource methods (such as `replies.update`) require a `replyId`. Use the `replies.list` method to retrieve the ID for a reply. "action": "A String", # The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen` + "assigneeEmailAddress": "A String", # Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset. "author": { # Information about a Drive user. # Output only. The author of the reply. The author's email address and permission ID will not be populated. "displayName": "A String", # Output only. A plain text displayable name for this user. "emailAddress": "A String", # Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. @@ -322,6 +343,9 @@

Method Details

"htmlContent": "A String", # Output only. The content of the reply with HTML formatting. "id": "A String", # Output only. The ID of the reply. "kind": "drive#reply", # Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#reply"`. + "mentionedEmailAddresses": [ # Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list. + "A String", + ], "modifiedTime": "A String", # The last time the reply was modified (RFC 3339 date-time). } diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 9da421777c..7fc61bfac0 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2720,7 +2720,7 @@ } } }, -"revision": "20251013", +"revision": "20251019", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3229,6 +3229,11 @@ "description": "A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).", "type": "string" }, +"assigneeEmailAddress": { +"description": "Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset.", +"readOnly": true, +"type": "string" +}, "author": { "$ref": "User", "description": "Output only. The author of the comment. The author's email address and permission ID will not be populated." @@ -3265,6 +3270,14 @@ "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#comment\"`.", "type": "string" }, +"mentionedEmailAddresses": { +"description": "Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "modifiedTime": { "description": "The last time the comment or any of its replies was modified (RFC 3339 date-time).", "format": "date-time", @@ -4768,6 +4781,11 @@ "description": "The action the reply performed to the parent comment. Valid values are: * `resolve` * `reopen`", "type": "string" }, +"assigneeEmailAddress": { +"description": "Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset.", +"readOnly": true, +"type": "string" +}, "author": { "$ref": "User", "description": "Output only. The author of the reply. The author's email address and permission ID will not be populated." @@ -4803,6 +4821,14 @@ "description": "Output only. Identifies what kind of resource this is. Value: the fixed string `\"drive#reply\"`.", "type": "string" }, +"mentionedEmailAddresses": { +"description": "Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "modifiedTime": { "description": "The last time the reply was modified (RFC 3339 date-time).", "format": "date-time", From 33cc60f6da2e139c26e4037a0b2bd26a688b956f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 36/70] feat(file): update the api #### file:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.DirectoryServicesConfig (Total Keys: 3) - schemas.Instance.properties.directoryServices.$ref (Total Keys: 1) - schemas.LdapConfig (Total Keys: 7) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) #### file:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- .../file_v1.projects.locations.instances.html | 40 ++++++++++++++ ...file_v1.projects.locations.operations.html | 8 ++- ...v1beta1.projects.locations.operations.html | 8 ++- .../discovery_cache/documents/file.v1.json | 55 ++++++++++++++++++- .../documents/file.v1beta1.json | 14 ++++- 5 files changed, 119 insertions(+), 6 deletions(-) diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index 6f54c68abf..9fdebcf7b7 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -131,6 +131,16 @@

Method Details

"deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). + "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + "ldap": { # LdapConfig contains all the parameters for connecting to LDAP servers. # Configuration for LDAP servers. + "domain": "A String", # Required. The LDAP domain name in the format of `my-domain.com`. + "groupsOu": "A String", # Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + "servers": [ # Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses. + "A String", + ], + "usersOu": "A String", # Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + }, + }, "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. { # File share configuration for the instance. @@ -305,6 +315,16 @@

Method Details

"deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). + "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + "ldap": { # LdapConfig contains all the parameters for connecting to LDAP servers. # Configuration for LDAP servers. + "domain": "A String", # Required. The LDAP domain name in the format of `my-domain.com`. + "groupsOu": "A String", # Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + "servers": [ # Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses. + "A String", + ], + "usersOu": "A String", # Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + }, + }, "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. { # File share configuration for the instance. @@ -420,6 +440,16 @@

Method Details

"deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). + "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + "ldap": { # LdapConfig contains all the parameters for connecting to LDAP servers. # Configuration for LDAP servers. + "domain": "A String", # Required. The LDAP domain name in the format of `my-domain.com`. + "groupsOu": "A String", # Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + "servers": [ # Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses. + "A String", + ], + "usersOu": "A String", # Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + }, + }, "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. { # File share configuration for the instance. @@ -544,6 +574,16 @@

Method Details

"deletionProtectionEnabled": True or False, # Optional. Indicates whether the instance is protected against deletion. "deletionProtectionReason": "A String", # Optional. The reason for enabling deletion protection. "description": "A String", # The description of the instance (2048 characters or less). + "directoryServices": { # Directory Services configuration for Kerberos-based authentication. # Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is "NFS_V4_1". + "ldap": { # LdapConfig contains all the parameters for connecting to LDAP servers. # Configuration for LDAP servers. + "domain": "A String", # Required. The LDAP domain name in the format of `my-domain.com`. + "groupsOu": "A String", # Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + "servers": [ # Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses. + "A String", + ], + "usersOu": "A String", # Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace. + }, + }, "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. { # File share configuration for the instance. diff --git a/docs/dyn/file_v1.projects.locations.operations.html b/docs/dyn/file_v1.projects.locations.operations.html index beaf74ba2c..0b541f6003 100644 --- a/docs/dyn/file_v1.projects.locations.operations.html +++ b/docs/dyn/file_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/file_v1beta1.projects.locations.operations.html b/docs/dyn/file_v1beta1.projects.locations.operations.html index f050f6839a..f4c2e6ace6 100644 --- a/docs/dyn/file_v1beta1.projects.locations.operations.html +++ b/docs/dyn/file_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index e66ccf2eca..2a9058ed7c 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -891,6 +891,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -908,7 +913,7 @@ } } }, -"revision": "20250929", +"revision": "20251015", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1113,6 +1118,17 @@ }, "type": "object" }, +"DirectoryServicesConfig": { +"description": "Directory Services configuration for Kerberos-based authentication.", +"id": "DirectoryServicesConfig", +"properties": { +"ldap": { +"$ref": "LdapConfig", +"description": "Configuration for LDAP servers." +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1486,6 +1502,10 @@ "description": "The description of the instance (2048 characters or less).", "type": "string" }, +"directoryServices": { +"$ref": "DirectoryServicesConfig", +"description": "Optional. Directory Services configuration for Kerberos-based authentication. Should only be set if protocol is \"NFS_V4_1\"." +}, "etag": { "description": "Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.", "type": "string" @@ -1659,6 +1679,32 @@ }, "type": "object" }, +"LdapConfig": { +"description": "LdapConfig contains all the parameters for connecting to LDAP servers.", +"id": "LdapConfig", +"properties": { +"domain": { +"description": "Required. The LDAP domain name in the format of `my-domain.com`.", +"type": "string" +}, +"groupsOu": { +"description": "Optional. The groups Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.", +"type": "string" +}, +"servers": { +"description": "Required. The servers names are used for specifying the LDAP servers names. The LDAP servers names can come with two formats: 1. DNS name, for example: `ldap.example1.com`, `ldap.example2.com`. 2. IP address, for example: `10.0.0.1`, `10.0.0.2`, `10.0.0.3`. All servers names must be in the same format: either all DNS names or all IP addresses.", +"items": { +"type": "string" +}, +"type": "array" +}, +"usersOu": { +"description": "Optional. The users Organizational Unit (OU) is optional. This parameter is a hint to allow faster lookup in the LDAP namespace. In case that this parameter is not provided, Filestore instance will query the whole LDAP namespace.", +"type": "string" +} +}, +"type": "object" +}, "ListBackupsResponse": { "description": "ListBackupsResponse is the result of ListBackupsRequest.", "id": "ListBackupsResponse", @@ -1741,6 +1787,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index 15d2818f3d..f8c3afee3a 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -1114,6 +1114,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -1131,7 +1136,7 @@ } } }, -"revision": "20250929", +"revision": "20251015", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -2037,6 +2042,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From d228cb515590e17fdbb2732f667db09940ff65f0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 37/70] feat(firebaseappdistribution): update the api #### firebaseappdistribution:v1alpha The following keys were added: - resources.projects.resources.apps.resources.testCases.methods.clearTestCaseCache (Total Keys: 12) - schemas.GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest (Total Keys: 4) - schemas.GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse (Total Keys: 2) - schemas.GoogleFirebaseAppdistroV1alphaDeviceExecution.properties.executionType (Total Keys: 2) --- ..._v1alpha.projects.apps.releases.tests.html | 4 ++ ...ution_v1alpha.projects.apps.testCases.html | 35 ++++++++++ .../firebaseappdistribution.v1alpha.json | 67 ++++++++++++++++++- 3 files changed, 105 insertions(+), 1 deletion(-) diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 0e2862beda..4a092324d6 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -249,6 +249,7 @@

Method Details

"orientation": "A String", # Optional. The orientation of the device during the test. "version": "A String", # Required. The version of the device (API level on Android). }, + "executionType": "A String", # Output only. The type of execution for the test. "failedReason": "A String", # Output only. The reason why the test failed. "inconclusiveReason": "A String", # Output only. The reason why the test was inconclusive. "resultsStoragePath": "A String", # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait. @@ -414,6 +415,7 @@

Method Details

"orientation": "A String", # Optional. The orientation of the device during the test. "version": "A String", # Required. The version of the device (API level on Android). }, + "executionType": "A String", # Output only. The type of execution for the test. "failedReason": "A String", # Output only. The reason why the test failed. "inconclusiveReason": "A String", # Output only. The reason why the test was inconclusive. "resultsStoragePath": "A String", # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait. @@ -585,6 +587,7 @@

Method Details

"orientation": "A String", # Optional. The orientation of the device during the test. "version": "A String", # Required. The version of the device (API level on Android). }, + "executionType": "A String", # Output only. The type of execution for the test. "failedReason": "A String", # Output only. The reason why the test failed. "inconclusiveReason": "A String", # Output only. The reason why the test was inconclusive. "resultsStoragePath": "A String", # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait. @@ -766,6 +769,7 @@

Method Details

"orientation": "A String", # Optional. The orientation of the device during the test. "version": "A String", # Required. The version of the device (API level on Android). }, + "executionType": "A String", # Output only. The type of execution for the test. "failedReason": "A String", # Output only. The reason why the test failed. "inconclusiveReason": "A String", # Output only. The reason why the test was inconclusive. "resultsStoragePath": "A String", # Output only. The path to a directory in Cloud Storage that will eventually contain the results for this execution. For example, gs://bucket/Nexus5-18-en-portrait. diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html index 66da019289..034fc82c4d 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html @@ -80,6 +80,9 @@

Instance Methods

batchUpdate(parent, body=None, x__xgafv=None)

Updates multiple test cases.

+

+ clearTestCaseCache(testCase, body=None, x__xgafv=None)

+

Clears cached test runs for a specific test case and device(s).

close()

Close httplib2 connections.

@@ -200,6 +203,38 @@

Method Details

} +
+ clearTestCaseCache(testCase, body=None, x__xgafv=None) + 
Clears cached test runs for a specific test case and device(s).
+
+Args:
+  testCase: string, Required. The name of the test case resource for which to clear the cache. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `ClearTestCaseCache`.
+  "testDevices": [ # Optional. The list of devices for which to clear the cache. If not present, clear all of them.
+    { # A device on which automated tests can be run.
+      "locale": "A String", # Optional. The locale of the device (e.g. "en_US" for US English) during the test.
+      "model": "A String", # Required. The device model.
+      "orientation": "A String", # Optional. The orientation of the device during the test.
+      "version": "A String", # Required. The version of the device (API level on Android).
+    },
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response empty (google.protobuf.Empty) message for `ClearTestCaseCache`
+}
+
+
close() 
Close httplib2 connections.
diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index a63de9fbd4..a35a8b7b16 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -647,6 +647,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"clearTestCaseCache": { +"description": "Clears cached test runs for a specific test case and device(s).", +"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases/{testCasesId}:clearTestCaseCache", +"httpMethod": "POST", +"id": "firebaseappdistribution.projects.apps.testCases.clearTestCaseCache", +"parameterOrder": [ +"testCase" +], +"parameters": { +"testCase": { +"description": "Required. The name of the test case resource for which to clear the cache. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`", +"location": "path", +"pattern": "^projects/[^/]+/apps/[^/]+/testCases/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+testCase}:clearTestCaseCache", +"request": { +"$ref": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest" +}, +"response": { +"$ref": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Create a new test case.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/testCases", @@ -840,7 +868,7 @@ } } }, -"revision": "20251015", +"revision": "20251030", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -1225,6 +1253,26 @@ "properties": {}, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest": { +"description": "Request message for `ClearTestCaseCache`.", +"id": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheRequest", +"properties": { +"testDevices": { +"description": "Optional. The list of devices for which to clear the cache. If not present, clear all of them.", +"items": { +"$ref": "GoogleFirebaseAppdistroV1alphaTestDevice" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse": { +"description": "Response empty (google.protobuf.Empty) message for `ClearTestCaseCache`", +"id": "GoogleFirebaseAppdistroV1alphaClearTestCaseCacheResponse", +"properties": {}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest": { "description": "The request message for `CreateReleaseNotes`.", "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest", @@ -1288,6 +1336,23 @@ "$ref": "GoogleFirebaseAppdistroV1alphaTestDevice", "description": "Required. The device that the test was run on." }, +"executionType": { +"description": "Output only. The type of execution for the test.", +"enum": [ +"EXECUTION_TYPE_UNSPECIFIED", +"AI", +"ACTION_BASED_REPLAY", +"AI_REPLAY" +], +"enumDescriptions": [ +"Execution type unspecified.", +"An AI-driven test.", +"A replay of a previous test run.", +"A failed replay that was rerun using the AI agent." +], +"readOnly": true, +"type": "string" +}, "failedReason": { "description": "Output only. The reason why the test failed.", "enum": [ From 62fab0552fa333a8a79c0c433c515b029d743e3f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 38/70] feat(firebaseapphosting): update the api #### firebaseapphosting:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) #### firebaseapphosting:v1beta The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...firebaseapphosting_v1.projects.locations.html | 2 +- ...hosting_v1.projects.locations.operations.html | 8 ++++++-- ...baseapphosting_v1beta.projects.locations.html | 2 +- ...ing_v1beta.projects.locations.operations.html | 8 ++++++-- .../documents/firebaseapphosting.v1.json | 16 ++++++++++++++-- .../documents/firebaseapphosting.v1beta.json | 16 ++++++++++++++-- 6 files changed, 42 insertions(+), 10 deletions(-) diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.html b/docs/dyn/firebaseapphosting_v1.projects.locations.html index 321a11439f..42f773f1c0 100644 --- a/docs/dyn/firebaseapphosting_v1.projects.locations.html +++ b/docs/dyn/firebaseapphosting_v1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.operations.html b/docs/dyn/firebaseapphosting_v1.projects.locations.operations.html index 2191defb1e..eb02426b4f 100644 --- a/docs/dyn/firebaseapphosting_v1.projects.locations.operations.html +++ b/docs/dyn/firebaseapphosting_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.html index 0a4d0e9b74..7d1309a59b 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.operations.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.operations.html index e276a9d86d..6ec98e2074 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.operations.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -170,7 +170,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -178,6 +178,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -209,6 +210,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json index 828bc121ad..e044d91561 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1084,6 +1084,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1101,7 +1106,7 @@ } } }, -"revision": "20250904", +"revision": "20251023", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2121,6 +2126,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json index a442315485..e95d0de7bf 100644 --- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1081,6 +1081,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -1098,7 +1103,7 @@ } } }, -"revision": "20250918", +"revision": "20251023", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2147,6 +2152,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 5fc2c543b13bc466fccd2e89fef36fd6da5a905c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 39/70] feat(firebasedataconnect): update the api #### firebasedataconnect:v1 The following keys were deleted: - schemas.GraphqlErrorExtensions.properties.resource.type (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GraphqlErrorExtensions.properties.warningLevel.type (Total Keys: 1) - schemas.GraphqlErrorExtensions.properties.workarounds (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) - schemas.Workaround (Total Keys: 4) #### firebasedataconnect:v1beta The following keys were deleted: - schemas.GraphqlErrorExtensions.properties.resource.type (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.GraphqlErrorExtensions.properties.warningLevel.type (Total Keys: 1) - schemas.GraphqlErrorExtensions.properties.workarounds (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) - schemas.Workaround (Total Keys: 4) --- ...basedataconnect_v1.projects.locations.html | 2 +- ...nect_v1.projects.locations.operations.html | 8 ++- ...rojects.locations.services.connectors.html | 52 +++++++++++---- ...onnect_v1.projects.locations.services.html | 39 ++++++++--- ...1.projects.locations.services.schemas.html | 4 +- ...dataconnect_v1beta.projects.locations.html | 2 +- ..._v1beta.projects.locations.operations.html | 8 ++- ...rojects.locations.services.connectors.html | 52 +++++++++++---- ...ct_v1beta.projects.locations.services.html | 39 ++++++++--- ...a.projects.locations.services.schemas.html | 4 +- .../documents/firebasedataconnect.v1.json | 66 +++++++++++++++++-- .../documents/firebasedataconnect.v1beta.json | 66 +++++++++++++++++-- 12 files changed, 276 insertions(+), 66 deletions(-) diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.html b/docs/dyn/firebasedataconnect_v1.projects.locations.html index 697dc7396f..e228d0eb5d 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html b/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html index 67e66bd2f1..a2712ef5b2 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.connectors.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.connectors.html index fead8d2127..1f22cf8fd5 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.connectors.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.connectors.html @@ -247,14 +247,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -298,14 +305,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -397,14 +411,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -457,14 +478,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.html index 9c5edae396..7549aa461d 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.html @@ -256,14 +256,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -317,14 +324,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -409,14 +423,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html index e52937e22a..d05c61156f 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html @@ -88,7 +88,7 @@

Instance Methods

Gets details of a single Schema.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.

+

Lists Schemas in a given project and location.

list_next()

Retrieves the next page of results.

@@ -275,7 +275,7 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) - 
Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.
+  
Lists Schemas in a given project and location.
 
 Args:
   parent: string, Required. Value of parent. (required)
diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.html
index 1fcc4f2477..4f53149087 100644
--- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.html
+++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html
index d3cb185fb7..d18a868bc9 100644
--- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html
+++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.operations.html
@@ -87,7 +87,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -176,7 +176,7 @@ 
Method Details
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.connectors.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.connectors.html index bdfc69cfbe..061e9435f8 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.connectors.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.connectors.html @@ -247,14 +247,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -298,14 +305,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -397,14 +411,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -457,14 +478,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html index 044fbf3ed0..05c1ebbb60 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.html @@ -256,14 +256,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -317,14 +324,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. @@ -409,14 +423,21 @@

Method Details

"a_key": "", # Properties of the object. }, "errors": [ # Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors. - { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body. + { # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body. "extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information. "code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`. "debugDetails": "A String", # More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`. "file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`. - "resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`). + "warningLevel": "A String", # Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it. + "workarounds": [ # Workarounds provide suggestions to address the compile errors or warnings. + { # Workaround provides suggestions to address errors and warnings. + "description": "A String", # Description of this workaround. + "reason": "A String", # Why would this workaround address the error and warning. + "replace": "A String", # A suggested code snippet to fix the error and warning. + }, + ], }, - "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. + "locations": [ # The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source. { # SourceLocation references a location in a GraphQL source. "column": 42, # Column number starting at 1. "line": 42, # Line number starting at 1. diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html index f2553b189f..98ed415d28 100644 --- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html @@ -88,7 +88,7 @@

Instance Methods

Gets details of a single Schema.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.

+

Lists Schemas in a given project and location.

list_next()

Retrieves the next page of results.

@@ -275,7 +275,7 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) - 
Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.
+  
Lists Schemas in a given project and location.
 
 Args:
   parent: string, Required. Value of parent. (required)
diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json
index 0d0274c2d7..e2b598bee2 100644
--- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json
+++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -294,6 +294,11 @@
 "description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1/{+name}/operations",
@@ -1057,7 +1062,7 @@
 ]
 },
 "list": {
-"description": "Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.",
+"description": "Lists Schemas in a given project and location.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas",
 "httpMethod": "GET",
 "id": "firebasedataconnect.projects.locations.services.schemas.list",
@@ -1160,7 +1165,7 @@
 }
 }
 },
-"revision": "20250907",
+"revision": "20251026",
 "rootUrl": "https://firebasedataconnect.googleapis.com/",
 "schemas": {
 "CancelOperationRequest": {
@@ -1355,7 +1360,7 @@
 "type": "object"
 },
 "GraphqlError": {
-"description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.",
+"description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.",
 "id": "GraphqlError",
 "properties": {
 "extensions": {
@@ -1363,7 +1368,7 @@
 "description": "Additional error information."
 },
 "locations": {
-"description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.",
+"description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.",
 "items": {
 "$ref": "SourceLocation"
 },
@@ -1437,9 +1442,30 @@
 "description": "The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.",
 "type": "string"
 },
-"resource": {
-"description": "Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).",
+"warningLevel": {
+"description": "Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it.",
+"enum": [
+"WARNING_LEVEL_UNKNOWN",
+"LOG_ONLY",
+"INTERACTIVE_ACK",
+"REQUIRE_ACK",
+"REQUIRE_FORCE"
+],
+"enumDescriptions": [
+"Warning level is not specified.",
+"Display a warning without action needed.",
+"Request a confirmation in interactive deployment flow.",
+"Require an explicit confirmation in all deployment flows.",
+"Require --force in all deployment flows."
+],
 "type": "string"
+},
+"workarounds": {
+"description": "Workarounds provide suggestions to address the compile errors or warnings.",
+"items": {
+"$ref": "Workaround"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -1607,6 +1633,13 @@
 "$ref": "Operation"
 },
 "type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -2007,6 +2040,25 @@
 }
 },
 "type": "object"
+},
+"Workaround": {
+"description": "Workaround provides suggestions to address errors and warnings.",
+"id": "Workaround",
+"properties": {
+"description": {
+"description": "Description of this workaround.",
+"type": "string"
+},
+"reason": {
+"description": "Why would this workaround address the error and warning.",
+"type": "string"
+},
+"replace": {
+"description": "A suggested code snippet to fix the error and warning.",
+"type": "string"
+}
+},
+"type": "object"
 }
 },
 "servicePath": "",
diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json
index fb04ff1d28..d9fc87bcd0 100644
--- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -294,6 +294,11 @@
 "description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1beta/{+name}/operations",
@@ -1057,7 +1062,7 @@
 ]
 },
 "list": {
-"description": "Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.",
+"description": "Lists Schemas in a given project and location.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas",
 "httpMethod": "GET",
 "id": "firebasedataconnect.projects.locations.services.schemas.list",
@@ -1160,7 +1165,7 @@
 }
 }
 },
-"revision": "20250907",
+"revision": "20251026",
 "rootUrl": "https://firebasedataconnect.googleapis.com/",
 "schemas": {
 "CancelOperationRequest": {
@@ -1355,7 +1360,7 @@
 "type": "object"
 },
 "GraphqlError": {
-"description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.",
+"description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.",
 "id": "GraphqlError",
 "properties": {
 "extensions": {
@@ -1363,7 +1368,7 @@
 "description": "Additional error information."
 },
 "locations": {
-"description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.",
+"description": "The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.",
 "items": {
 "$ref": "SourceLocation"
 },
@@ -1437,9 +1442,30 @@
 "description": "The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.",
 "type": "string"
 },
-"resource": {
-"description": "Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).",
+"warningLevel": {
+"description": "Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it.",
+"enum": [
+"WARNING_LEVEL_UNKNOWN",
+"LOG_ONLY",
+"INTERACTIVE_ACK",
+"REQUIRE_ACK",
+"REQUIRE_FORCE"
+],
+"enumDescriptions": [
+"Warning level is not specified.",
+"Display a warning without action needed.",
+"Request a confirmation in interactive deployment flow.",
+"Require an explicit confirmation in all deployment flows.",
+"Require --force in all deployment flows."
+],
 "type": "string"
+},
+"workarounds": {
+"description": "Workarounds provide suggestions to address the compile errors or warnings.",
+"items": {
+"$ref": "Workaround"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -1607,6 +1633,13 @@
 "$ref": "Operation"
 },
 "type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -2007,6 +2040,25 @@
 }
 },
 "type": "object"
+},
+"Workaround": {
+"description": "Workaround provides suggestions to address errors and warnings.",
+"id": "Workaround",
+"properties": {
+"description": {
+"description": "Description of this workaround.",
+"type": "string"
+},
+"reason": {
+"description": "Why would this workaround address the error and warning.",
+"type": "string"
+},
+"replace": {
+"description": "A suggested code snippet to fix the error and warning.",
+"type": "string"
+}
+},
+"type": "object"
 }
 },
 "servicePath": "",

From aacb9659d60bed0a38c05936c788d6c96eb30599 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:14 +0000
Subject: [PATCH 40/70] feat(gkeonprem): update the api

#### gkeonprem:v1

The following keys were added:
- resources.projects.resources.locations.resources.bareMetalAdminClusters.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.bareMetalClusters.resources.bareMetalNodePools.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.bareMetalClusters.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.vmwareAdminClusters.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.vmwareClusters.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.vmwareClusters.resources.vmwareNodePools.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
---
 ...ons.bareMetalAdminClusters.operations.html |  8 +++-
 ...lusters.bareMetalNodePools.operations.html |  8 +++-
 ...ocations.bareMetalClusters.operations.html |  8 +++-
 docs/dyn/gkeonprem_v1.projects.locations.html |  2 +-
 ...prem_v1.projects.locations.operations.html |  8 +++-
 ...ations.vmwareAdminClusters.operations.html |  8 +++-
 ...s.locations.vmwareClusters.operations.html |  8 +++-
 ...reClusters.vmwareNodePools.operations.html |  8 +++-
 .../documents/gkeonprem.v1.json               | 46 ++++++++++++++++++-
 9 files changed, 87 insertions(+), 17 deletions(-)

diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html
index 7f4615c781..e4f4e76223 100644
--- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html
+++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalAdminClusters.operations.html
@@ -81,7 +81,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -128,7 +128,7 @@ 
Method Details
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html index 68a7ddfaf3..e46bc220ba 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.bareMetalNodePools.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html index eb0aaa211b..b12b9eb557 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.bareMetalClusters.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.html b/docs/dyn/gkeonprem_v1.projects.locations.html index 014dc63803..77d2d02c1e 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkeonprem_v1.projects.locations.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.operations.html index 186de572dc..29be13c9ac 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html index 79833c029e..2c3bedd6f4 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareAdminClusters.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html index 8bcffe23ee..ed86be7352 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html index 2422e67685..eaa41ac08d 100644 --- a/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html +++ b/docs/dyn/gkeonprem_v1.projects.locations.vmwareClusters.vmwareNodePools.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json index 578cfcca10..b0dd0acfa1 100644 --- a/googleapiclient/discovery_cache/documents/gkeonprem.v1.json +++ b/googleapiclient/discovery_cache/documents/gkeonprem.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -618,6 +618,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1514,6 +1519,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1586,6 +1596,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -1711,6 +1726,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2128,6 +2148,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -2642,6 +2667,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3084,6 +3114,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3105,7 +3140,7 @@ } } }, -"revision": "20250908", +"revision": "20251022", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -4797,6 +4832,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From ac074ed9332b6ebaa776c9ef7123d708fea89b8b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 41/70] feat(healthcare): update the api #### healthcare:v1 The following keys were added: - schemas.FhirStoreMetric.properties.versionedStorageSizeBytes (Total Keys: 2) #### healthcare:v1beta1 The following keys were added: - schemas.FhirStoreMetric.properties.versionedStorageSizeBytes (Total Keys: 2) --- ...e_v1.projects.locations.datasets.fhirStores.fhir.html | 4 ++-- ...thcare_v1.projects.locations.datasets.fhirStores.html | 1 + ...eta1.projects.locations.datasets.fhirStores.fhir.html | 4 ++-- ...e_v1beta1.projects.locations.datasets.fhirStores.html | 1 + .../discovery_cache/documents/healthcare.v1.json | 9 +++++++-- .../discovery_cache/documents/healthcare.v1beta1.json | 9 +++++++-- 6 files changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html index 1f4805b29c..ae25746e33 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.fhir.html @@ -115,7 +115,7 @@

Instance Methods

Deletes a FHIR resource that match an identifier search query. Implements the FHIR standard conditional delete interaction, limited to searching by resource identifier. If multiple resources match, 412 Precondition Failed error will be returned. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resource is moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).

conditionalPatch(parent, type, body=None, x__xgafv=None)

-

If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).

+

If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).

conditionalUpdate(parent, type, body=None, x__xgafv=None)

If a resource is found with the identifier specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction, limited to searching by resource identifier. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).

@@ -496,7 +496,7 @@

Method Details

conditionalPatch(parent, type, body=None, x__xgafv=None) - 
If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).
+  
If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).
 
 Args:
   parent: string, Required. The name of the FHIR store this resource belongs to. (required)
diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
index b5385e5639..172b789e90 100644
--- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html
@@ -1094,6 +1094,7 @@ 
Method Details

       "count": "A String", # The total count of FHIR resources in the store of this resource type.
       "resourceType": "A String", # The FHIR resource type this metric applies to.
       "structuredStorageSizeBytes": "A String", # The total amount of structured storage used by FHIR resources of this resource type in the store.
+      "versionedStorageSizeBytes": "A String", # The total amount of versioned storage used by versioned FHIR resources of this resource type in the store.
     },
   ],
   "name": "A String", # The resource name of the FHIR store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html
index f006bbbf06..94d6dcbf53 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.fhir.html
@@ -130,7 +130,7 @@ 
Instance Methods

 
Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](https://hl7.org/fhir/STU3/http.html#2.21.0.13.1), [R4](https://hl7.org/fhir/R4/http.html#3.1.0.7.1), [R5](https://hl7.org/fhir/R5/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Not all FHIR resources that match the search query might be deleted because, by default, a maximum of 100 FHIR resources can be deleted. The number of FHIR resources that can be deleted depends on the page size of the returned resources, which you can control using the `_count` query parameter. Even when using `_count`, you can delete a maximum 1,000 FHIR resources per each call of `conditionalDelete`. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see [Conditionally deleting a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir_resource).

 

   conditionalPatch(parent, type, body=None, x__xgafv=None)

-
If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).

+
If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).

 

   conditionalUpdate(parent, type, body=None, x__xgafv=None)

 
If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](https://hl7.org/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](https://hl7.org/fhir/STU3/http.html#cond-update), [R4](https://hl7.org/fhir/R4/http.html#cond-update), [R5](https://hl7.org/fhir/R5/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see [Conditionally updating a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir_resource).

@@ -654,7 +654,7 @@ 
Method Details

 
 

     conditionalPatch(parent, type, body=None, x__xgafv=None)
-  
If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).
+  
If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).
 
 Args:
   parent: string, Required. The name of the FHIR store this resource belongs to. (required)
diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
index 23b080b6d5..8dcfbca8bb 100644
--- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
+++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html
@@ -1650,6 +1650,7 @@ 
Method Details

       "count": "A String", # The total count of FHIR resources in the store of this resource type.
       "resourceType": "A String", # The FHIR resource type this metric applies to.
       "structuredStorageSizeBytes": "A String", # The total amount of structured storage used by FHIR resources of this resource type in the store.
+      "versionedStorageSizeBytes": "A String", # The total amount of versioned storage used by versioned FHIR resources of this resource type in the store.
     },
   ],
   "name": "A String", # The resource name of the FHIR store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json
index 954083c649..a58fcefb04 100644
--- a/googleapiclient/discovery_cache/documents/healthcare.v1.json
+++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json
@@ -3930,7 +3930,7 @@
 ]
 },
 "conditionalPatch": {
-"description": "If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).",
+"description": "If a resource is found with the identifier specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction, limited to searching by resource identifier. DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search term for identifier should be in the pattern `identifier=system|value` or `identifier=value` - similar to the `search` method on resources with a specific identifier. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
 "httpMethod": "PATCH",
 "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch",
@@ -5137,7 +5137,7 @@
 }
 }
 },
-"revision": "20251001",
+"revision": "20251009",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "AccessDeterminationLogConfig": {
@@ -6839,6 +6839,11 @@
 "description": "The total amount of structured storage used by FHIR resources of this resource type in the store.",
 "format": "int64",
 "type": "string"
+},
+"versionedStorageSizeBytes": {
+"description": "The total amount of versioned storage used by versioned FHIR resources of this resource type in the store.",
+"format": "int64",
+"type": "string"
 }
 },
 "type": "object"
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
index b39945e88c..aeaaf49c8a 100644
--- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
@@ -4424,7 +4424,7 @@
 ]
 },
 "conditionalPatch": {
-"description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).",
+"description": "If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](https://hl7.org/fhir/STU3/http.html#patch), [R4](https://hl7.org/fhir/R4/http.html#patch), [R5](https://hl7.org/fhir/R5/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria doesn't identify any matches, the request returns a `404 Not Found` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see [Conditionally patching a FHIR resource](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir_resource).",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/{fhirId}",
 "httpMethod": "PATCH",
 "id": "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch",
@@ -5684,7 +5684,7 @@
 }
 }
 },
-"revision": "20251001",
+"revision": "20251009",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "AccessDeterminationLogConfig": {
@@ -7656,6 +7656,11 @@
 "description": "The total amount of structured storage used by FHIR resources of this resource type in the store.",
 "format": "int64",
 "type": "string"
+},
+"versionedStorageSizeBytes": {
+"description": "The total amount of versioned storage used by versioned FHIR resources of this resource type in the store.",
+"format": "int64",
+"type": "string"
 }
 },
 "type": "object"

From a668b6ab59c1c913ed455c94e722cd0747850c9f Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:14 +0000
Subject: [PATCH 42/70] feat(iamcredentials): update the api

#### iamcredentials:v1

The following keys were deleted:
- resources.locations.resources.workforcePools.methods.getAllowedLocations (Total Keys: 10)
- resources.projects.resources.locations.resources.workloadIdentityPools.methods.getAllowedLocations (Total Keys: 10)
- resources.projects.resources.serviceAccounts.methods.getAllowedLocations (Total Keys: 10)
- schemas.ServiceAccountAllowedLocations (Total Keys: 7)
- schemas.WorkforcePoolAllowedLocations (Total Keys: 7)
- schemas.WorkloadIdentityPoolAllowedLocations (Total Keys: 7)
---
 docs/dyn/iamcredentials_v1.html               |   5 -
 docs/dyn/iamcredentials_v1.projects.html      |   5 -
 ...edentials_v1.projects.serviceAccounts.html |  25 ---
 .../documents/iamcredentials.v1.json          | 144 +-----------------
 4 files changed, 1 insertion(+), 178 deletions(-)

diff --git a/docs/dyn/iamcredentials_v1.html b/docs/dyn/iamcredentials_v1.html
index 749a6c1797..6e0cb1cc2d 100644
--- a/docs/dyn/iamcredentials_v1.html
+++ b/docs/dyn/iamcredentials_v1.html
@@ -74,11 +74,6 @@
 
 
IAM Service Account Credentials API

 
Instance Methods

-

-  locations()
-

-
Returns the locations Resource.

-
 

   projects()
 

diff --git a/docs/dyn/iamcredentials_v1.projects.html b/docs/dyn/iamcredentials_v1.projects.html
index b3afd8431e..be2709b3db 100644
--- a/docs/dyn/iamcredentials_v1.projects.html
+++ b/docs/dyn/iamcredentials_v1.projects.html
@@ -74,11 +74,6 @@
 
 
IAM Service Account Credentials API . projects

 
Instance Methods

-

-  locations()
-

-
Returns the locations Resource.

-
 

   serviceAccounts()
 

diff --git a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
index ced1bad9f1..d59bed92b7 100644
--- a/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
+++ b/docs/dyn/iamcredentials_v1.projects.serviceAccounts.html
@@ -83,9 +83,6 @@ 
Instance Methods

 

   generateIdToken(name, body=None, x__xgafv=None)

 
Generates an OpenID Connect ID token for a service account.

-

-  getAllowedLocations(name, x__xgafv=None)

-
Returns the trust boundary info for a given service account.

 

   signBlob(name, body=None, x__xgafv=None)

 
Signs a blob using a service account's system-managed private key.

@@ -162,28 +159,6 @@ 
Method Details

 }

 

 
-

-    getAllowedLocations(name, x__xgafv=None)
-  
Returns the trust boundary info for a given service account.
-
-Args:
-  name: string, Required. Resource name of service account. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents a list of allowed locations for given service account.
-  "encodedLocations": "A String", # Output only. The hex encoded bitmap of the trust boundary locations
-  "locations": [ # Output only. The human readable trust boundary locations. For example, ["us-central1", "europe-west1"]
-    "A String",
-  ],
-}

-

-
 

     signBlob(name, body=None, x__xgafv=None)
   
Signs a blob using a service account's system-managed private key.
diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json
index b16a18bf48..08036192f1 100644
--- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json
+++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json
@@ -137,68 +137,8 @@
 },
 "protocol": "rest",
 "resources": {
-"locations": {
-"resources": {
-"workforcePools": {
-"methods": {
-"getAllowedLocations": {
-"description": "Returns the trust boundary info for a given workforce pool.",
-"flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/allowedLocations",
-"httpMethod": "GET",
-"id": "iamcredentials.locations.workforcePools.getAllowedLocations",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. Resource name of workforce pool.",
-"location": "path",
-"pattern": "^locations/[^/]+/workforcePools/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}/allowedLocations",
-"response": {
-"$ref": "WorkforcePoolAllowedLocations"
-}
-}
-}
-}
-}
-},
 "projects": {
 "resources": {
-"locations": {
-"resources": {
-"workloadIdentityPools": {
-"methods": {
-"getAllowedLocations": {
-"description": "Returns the trust boundary info for a given workload identity pool.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/allowedLocations",
-"httpMethod": "GET",
-"id": "iamcredentials.projects.locations.workloadIdentityPools.getAllowedLocations",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. Resource name of workload identity pool.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/workloadIdentityPools/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}/allowedLocations",
-"response": {
-"$ref": "WorkloadIdentityPoolAllowedLocations"
-}
-}
-}
-}
-}
-},
 "serviceAccounts": {
 "methods": {
 "generateAccessToken": {
@@ -257,28 +197,6 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getAllowedLocations": {
-"description": "Returns the trust boundary info for a given service account.",
-"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/allowedLocations",
-"httpMethod": "GET",
-"id": "iamcredentials.projects.serviceAccounts.getAllowedLocations",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "Required. Resource name of service account.",
-"location": "path",
-"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+name}/allowedLocations",
-"response": {
-"$ref": "ServiceAccountAllowedLocations"
-}
-},
 "signBlob": {
 "description": "Signs a blob using a service account's system-managed private key.",
 "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
@@ -340,7 +258,7 @@
 }
 }
 },
-"revision": "20250911",
+"revision": "20251009",
 "rootUrl": "https://iamcredentials.googleapis.com/",
 "schemas": {
 "GenerateAccessTokenRequest": {
@@ -418,26 +336,6 @@
 },
 "type": "object"
 },
-"ServiceAccountAllowedLocations": {
-"description": "Represents a list of allowed locations for given service account.",
-"id": "ServiceAccountAllowedLocations",
-"properties": {
-"encodedLocations": {
-"description": "Output only. The hex encoded bitmap of the trust boundary locations",
-"readOnly": true,
-"type": "string"
-},
-"locations": {
-"description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]",
-"items": {
-"type": "string"
-},
-"readOnly": true,
-"type": "array"
-}
-},
-"type": "object"
-},
 "SignBlobRequest": {
 "id": "SignBlobRequest",
 "properties": {
@@ -501,46 +399,6 @@
 }
 },
 "type": "object"
-},
-"WorkforcePoolAllowedLocations": {
-"description": "Represents a list of allowed locations for given workforce pool.",
-"id": "WorkforcePoolAllowedLocations",
-"properties": {
-"encodedLocations": {
-"description": "Output only. The hex encoded bitmap of the trust boundary locations",
-"readOnly": true,
-"type": "string"
-},
-"locations": {
-"description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]",
-"items": {
-"type": "string"
-},
-"readOnly": true,
-"type": "array"
-}
-},
-"type": "object"
-},
-"WorkloadIdentityPoolAllowedLocations": {
-"description": "Represents a list of allowed locations for given workload identity pool.",
-"id": "WorkloadIdentityPoolAllowedLocations",
-"properties": {
-"encodedLocations": {
-"description": "Output only. The hex encoded bitmap of the trust boundary locations",
-"readOnly": true,
-"type": "string"
-},
-"locations": {
-"description": "Output only. The human readable trust boundary locations. For example, [\"us-central1\", \"europe-west1\"]",
-"items": {
-"type": "string"
-},
-"readOnly": true,
-"type": "array"
-}
-},
-"type": "object"
 }
 },
 "servicePath": "",

From e03595989016a96400343dbaa03371a049656d50 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:14 +0000
Subject: [PATCH 43/70] feat(ids): update the api

#### ids:v1

The following keys were added:
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
---
 docs/dyn/ids_v1.projects.locations.html          |  2 +-
 .../ids_v1.projects.locations.operations.html    |  8 ++++++--
 .../discovery_cache/documents/ids.v1.json        | 16 ++++++++++++++--
 3 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/docs/dyn/ids_v1.projects.locations.html b/docs/dyn/ids_v1.projects.locations.html
index 3a5d73f7cf..889b3210ce 100644
--- a/docs/dyn/ids_v1.projects.locations.html
+++ b/docs/dyn/ids_v1.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/ids_v1.projects.locations.operations.html b/docs/dyn/ids_v1.projects.locations.operations.html
index 726ffb1189..06da9814b3 100644
--- a/docs/dyn/ids_v1.projects.locations.operations.html
+++ b/docs/dyn/ids_v1.projects.locations.operations.html
@@ -87,7 +87,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -176,7 +176,7 @@ 
Method Details

 

 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
   
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }

 

 
diff --git a/googleapiclient/discovery_cache/documents/ids.v1.json b/googleapiclient/discovery_cache/documents/ids.v1.json
index 641675633c..b9c76fbbdb 100644
--- a/googleapiclient/discovery_cache/documents/ids.v1.json
+++ b/googleapiclient/discovery_cache/documents/ids.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -476,6 +476,11 @@
 "description": "The standard list page token.",
 "location": "query",
 "type": "string"
+},
+"returnPartialSuccess": {
+"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
+"location": "query",
+"type": "boolean"
 }
 },
 "path": "v1/{+name}/operations",
@@ -493,7 +498,7 @@
 }
 }
 },
-"revision": "20250320",
+"revision": "20251020",
 "rootUrl": "https://ids.googleapis.com/",
 "schemas": {
 "CancelOperationRequest": {
@@ -673,6 +678,13 @@
 "$ref": "Operation"
 },
 "type": "array"
+},
+"unreachable": {
+"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.",
+"items": {
+"type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"

From 652fd598fcd529c3da0563990bf7f4941b172f55 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:14 +0000
Subject: [PATCH 44/70] feat(logging): update the api

#### logging:v2

The following keys were added:
- resources.billingAccounts.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.folders.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.organizations.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
---
 ....billingAccounts.locations.operations.html |  8 +++--
 ...gging_v2.folders.locations.operations.html |  8 +++--
 docs/dyn/logging_v2.locations.operations.html |  8 +++--
 ...v2.organizations.locations.operations.html |  8 +++--
 ...ging_v2.projects.locations.operations.html |  8 +++--
 .../discovery_cache/documents/logging.v2.json | 34 ++++++++++++++++++-
 6 files changed, 63 insertions(+), 11 deletions(-)

diff --git a/docs/dyn/logging_v2.billingAccounts.locations.operations.html b/docs/dyn/logging_v2.billingAccounts.locations.operations.html
index fb2bcf13c7..a2a403645d 100644
--- a/docs/dyn/logging_v2.billingAccounts.locations.operations.html
+++ b/docs/dyn/logging_v2.billingAccounts.locations.operations.html
@@ -84,7 +84,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

 

   list_next()

@@ -155,7 +155,7 @@ 
Method Details
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -163,6 +163,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -194,6 +195,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/logging_v2.folders.locations.operations.html b/docs/dyn/logging_v2.folders.locations.operations.html index 84f2171247..2b25a460bf 100644 --- a/docs/dyn/logging_v2.folders.locations.operations.html +++ b/docs/dyn/logging_v2.folders.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -163,6 +163,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -194,6 +195,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/logging_v2.locations.operations.html b/docs/dyn/logging_v2.locations.operations.html index 17158d67c4..24bffa1bc3 100644 --- a/docs/dyn/logging_v2.locations.operations.html +++ b/docs/dyn/logging_v2.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -163,6 +163,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -194,6 +195,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/logging_v2.organizations.locations.operations.html b/docs/dyn/logging_v2.organizations.locations.operations.html index f83af95c95..d23231b92b 100644 --- a/docs/dyn/logging_v2.organizations.locations.operations.html +++ b/docs/dyn/logging_v2.organizations.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -163,6 +163,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -194,6 +195,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/logging_v2.projects.locations.operations.html b/docs/dyn/logging_v2.projects.locations.operations.html index ec7ef8673e..6a13e0a1e2 100644 --- a/docs/dyn/logging_v2.projects.locations.operations.html +++ b/docs/dyn/logging_v2.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

list_next()

@@ -155,7 +155,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
 
 Args:
@@ -163,6 +163,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -194,6 +195,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 241cfa5fde..a8634b6084 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -1381,6 +1381,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -3470,6 +3475,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -4840,6 +4850,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -6300,6 +6315,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -8108,6 +8128,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v2/{+name}/operations", @@ -9127,7 +9152,7 @@ } } }, -"revision": "20250919", +"revision": "20251017", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -10096,6 +10121,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 483cba2bbcd375f8c6808e6ad386f8279b622fb6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:14 +0000 Subject: [PATCH 45/70] feat(looker): update the api #### looker:v1 The following keys were added: - schemas.ControlledEgressConfig (Total Keys: 5) - schemas.Instance.properties.controlledEgressConfig.$ref (Total Keys: 1) - schemas.Instance.properties.controlledEgressEnabled.type (Total Keys: 1) --- docs/dyn/looker_v1.projects.locations.html | 2 +- ...ooker_v1.projects.locations.instances.html | 28 +++++++++++++++++ .../discovery_cache/documents/looker.v1.json | 30 +++++++++++++++++-- 3 files changed, 57 insertions(+), 3 deletions(-) diff --git a/docs/dyn/looker_v1.projects.locations.html b/docs/dyn/looker_v1.projects.locations.html index 46e53fcde8..3fca5fa4e9 100644 --- a/docs/dyn/looker_v1.projects.locations.html +++ b/docs/dyn/looker_v1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/looker_v1.projects.locations.instances.html b/docs/dyn/looker_v1.projects.locations.instances.html index fda9f06497..e3e35c7e56 100644 --- a/docs/dyn/looker_v1.projects.locations.instances.html +++ b/docs/dyn/looker_v1.projects.locations.instances.html @@ -135,6 +135,13 @@

Method Details

}, "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. + "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. + "egressFqdns": [ # Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic. + "A String", + ], + "marketplaceEnabled": True or False, # Optional. Whether marketplace is enabled. + }, + "controlledEgressEnabled": True or False, # Optional. Whether controlled egress is enabled on the Looker instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. @@ -373,6 +380,13 @@

Method Details

}, "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. + "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. + "egressFqdns": [ # Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic. + "A String", + ], + "marketplaceEnabled": True or False, # Optional. Whether marketplace is enabled. + }, + "controlledEgressEnabled": True or False, # Optional. Whether controlled egress is enabled on the Looker instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. @@ -547,6 +561,13 @@

Method Details

}, "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. + "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. + "egressFqdns": [ # Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic. + "A String", + ], + "marketplaceEnabled": True or False, # Optional. Whether marketplace is enabled. + }, + "controlledEgressEnabled": True or False, # Optional. Whether controlled egress is enabled on the Looker instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. @@ -690,6 +711,13 @@

Method Details

}, "classType": "A String", # Optional. Storage class of the instance. "consumerNetwork": "A String", # Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance. + "controlledEgressConfig": { # Controlled egress configuration. # Optional. Controlled egress configuration. + "egressFqdns": [ # Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic. + "A String", + ], + "marketplaceEnabled": True or False, # Optional. Whether marketplace is enabled. + }, + "controlledEgressEnabled": True or False, # Optional. Whether controlled egress is enabled on the Looker instance. "createTime": "A String", # Output only. The time when the Looker instance provisioning was first requested. "customDomain": { # Custom domain information. # Custom domain configuration for the instance. "domain": "A String", # Domain name. diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index eec44070f2..d15b53aa92 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -715,7 +715,7 @@ } } }, -"revision": "20251001", +"revision": "20251021", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -738,6 +738,24 @@ "properties": {}, "type": "object" }, +"ControlledEgressConfig": { +"description": "Controlled egress configuration.", +"id": "ControlledEgressConfig", +"properties": { +"egressFqdns": { +"description": "Optional. List of fully qualified domain names to be added to the allowlist for outbound traffic.", +"items": { +"type": "string" +}, +"type": "array" +}, +"marketplaceEnabled": { +"description": "Optional. Whether marketplace is enabled.", +"type": "boolean" +} +}, +"type": "object" +}, "CustomDomain": { "description": "Custom domain information.", "id": "CustomDomain", @@ -975,6 +993,14 @@ "description": "Network name in the consumer project. Format: `projects/{project}/global/networks/{network}`. Note that the consumer network may be in a different GCP project than the consumer project that is hosting the Looker Instance.", "type": "string" }, +"controlledEgressConfig": { +"$ref": "ControlledEgressConfig", +"description": "Optional. Controlled egress configuration." +}, +"controlledEgressEnabled": { +"description": "Optional. Whether controlled egress is enabled on the Looker instance.", +"type": "boolean" +}, "createTime": { "description": "Output only. The time when the Looker instance provisioning was first requested.", "format": "google-datetime", From 94e3bc173770528969b1abd935ac393934f6fda4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 46/70] feat(managedkafka): update the api #### managedkafka:v1 The following keys were added: - endpoints (Total Keys: 1) --- ...v1.projects.locations.connectClusters.html | 8 ++++---- .../managedkafka_v1.projects.locations.html | 2 +- .../documents/managedkafka.v1.json | 19 ++++++++++++++----- 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html b/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html index 380688b969..6b4e0f2ca2 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html +++ b/docs/dyn/managedkafka_v1.projects.locations.connectClusters.html @@ -149,7 +149,7 @@

Method Details

"name": "A String", # Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id} "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. - "state": "A String", # Output only. The current state of the cluster. + "state": "A String", # Output only. The current state of the Kafka Connect cluster. "updateTime": "A String", # Output only. The time when the cluster was last updated. } @@ -268,7 +268,7 @@

Method Details

"name": "A String", # Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id} "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. - "state": "A String", # Output only. The current state of the cluster. + "state": "A String", # Output only. The current state of the Kafka Connect cluster. "updateTime": "A String", # Output only. The time when the cluster was last updated. } @@ -327,7 +327,7 @@

Method Details

"name": "A String", # Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id} "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. - "state": "A String", # Output only. The current state of the cluster. + "state": "A String", # Output only. The current state of the Kafka Connect cluster. "updateTime": "A String", # Output only. The time when the cluster was last updated. }, ], @@ -395,7 +395,7 @@

Method Details

"name": "A String", # Identifier. The name of the Kafka Connect cluster. Structured like: projects/{project_number}/locations/{location}/connectClusters/{connect_cluster_id} "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. - "state": "A String", # Output only. The current state of the cluster. + "state": "A String", # Output only. The current state of the Kafka Connect cluster. "updateTime": "A String", # Output only. The time when the cluster was last updated. } diff --git a/docs/dyn/managedkafka_v1.projects.locations.html b/docs/dyn/managedkafka_v1.projects.locations.html index 9576165a78..be0142ac80 100644 --- a/docs/dyn/managedkafka_v1.projects.locations.html +++ b/docs/dyn/managedkafka_v1.projects.locations.html @@ -145,7 +145,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json index c89ffbaf20..17645bfa75 100644 --- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json +++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json @@ -15,6 +15,13 @@ "description": "Manage Apache Kafka clusters and resources. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/managed-service-for-apache-kafka/docs", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://managedkafka.us-east7.rep.googleapis.com/", +"location": "us-east7" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -144,7 +151,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2939,7 +2946,7 @@ } } }, -"revision": "20251009", +"revision": "20251023", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3263,18 +3270,20 @@ "type": "boolean" }, "state": { -"description": "Output only. The current state of the cluster.", +"description": "Output only. The current state of the Kafka Connect cluster.", "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", -"DELETING" +"DELETING", +"DETACHED" ], "enumDescriptions": [ "A state was not specified.", "The cluster is being created.", "The cluster is active.", -"The cluster is being deleted." +"The cluster is being deleted.", +"The cluster is detached." ], "readOnly": true, "type": "string" From 0c7724bed0a2a426196ef51534339110635b34e4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 47/70] feat(marketingplatformadmin): update the api #### marketingplatformadmin:v1alpha The following keys were added: - resources.organizations.methods.findSalesPartnerManagedClients (Total Keys: 12) - resources.organizations.methods.list (Total Keys: 12) - resources.organizations.methods.reportPropertyUsage (Total Keys: 12) - schemas.BillInfo (Total Keys: 6) - schemas.ClientData (Total Keys: 5) - schemas.Date (Total Keys: 8) - schemas.FindSalesPartnerManagedClientsRequest (Total Keys: 3) - schemas.FindSalesPartnerManagedClientsResponse (Total Keys: 4) - schemas.ListOrganizationsResponse (Total Keys: 5) - schemas.Money (Total Keys: 7) - schemas.PropertyUsage (Total Keys: 12) - schemas.ReportPropertyUsageRequest (Total Keys: 3) - schemas.ReportPropertyUsageResponse (Total Keys: 5) --- ...ngplatformadmin_v1alpha.organizations.html | 153 +++++++++ .../marketingplatformadmin.v1alpha.json | 305 +++++++++++++++++- 2 files changed, 457 insertions(+), 1 deletion(-) diff --git a/docs/dyn/marketingplatformadmin_v1alpha.organizations.html b/docs/dyn/marketingplatformadmin_v1alpha.organizations.html index c5dc2d70d6..382edba0d9 100644 --- a/docs/dyn/marketingplatformadmin_v1alpha.organizations.html +++ b/docs/dyn/marketingplatformadmin_v1alpha.organizations.html @@ -82,15 +82,70 @@

Instance Methods

close()

Close httplib2 connections.

+

+ findSalesPartnerManagedClients(organization, body=None, x__xgafv=None)

+

Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.

get(name, x__xgafv=None)

Lookup for a single organization.

+

+ list(pageSize=None, pageToken=None, x__xgafv=None)

+

Returns a list of organizations that the user has access to.

+

+ list_next()

+

Retrieves the next page of results.

+

+ reportPropertyUsage(organization, body=None, x__xgafv=None)

+

Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.

Method Details

close() 
Close httplib2 connections.
+
+ findSalesPartnerManagedClients(organization, body=None, x__xgafv=None) + 
Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.
+
+Args:
+  organization: string, Required. The name of the sales partner organization. Format: organizations/{org_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for FindSalesPartnerManagedClients RPC.
+  "isActive": True or False, # Optional. If set, only active and just ended clients will be returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for FindSalesPartnerManagedClients RPC.
+  "clientData": [ # The clients managed by the sales org.
+    { # Contains the client data.
+      "endDate": { # 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 # The end date of the contract between the sales org and the end client.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "organization": { # A resource message representing a Google Marketing Platform organization. # The end client that has/had contract with the requested sales org.
+        "displayName": "A String", # The human-readable name for the organization.
+        "name": "A String", # Identifier. The resource name of the GMP organization. Format: organizations/{org_id}
+      },
+      "startDate": { # 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 # The start date of the contract between the sales org and the end client.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+    },
+  ],
+}
+
+
get(name, x__xgafv=None) 
Lookup for a single organization.
@@ -111,4 +166,102 @@ 
Method Details

 }
+
+ list(pageSize=None, pageToken=None, x__xgafv=None) + 
Returns a list of organizations that the user has access to.
+
+Args:
+  pageSize: integer, Optional. The maximum number of organizations to return in one call. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOrganizations` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListOrganizations RPC.
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "organizations": [ # The Organization resource that the user has access to, which includes the org id and display name.
+    { # A resource message representing a Google Marketing Platform organization.
+      "displayName": "A String", # The human-readable name for the organization.
+      "name": "A String", # Identifier. The resource name of the GMP organization. Format: organizations/{org_id}
+    },
+  ],
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ reportPropertyUsage(organization, body=None, x__xgafv=None) + 
Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.
+
+Args:
+  organization: string, Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ReportPropertyUsage RPC.
+  "month": "A String", # Required. The target month to list property usages. Format: YYYY-MM. For example, "2025-05"
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ReportPropertyUsage RPC.
+  "billInfo": { # Contains the bill amount. # Bill amount in the specified organization and month. Will be empty if user only has access to usage data.
+    "baseFee": { # Represents an amount of money with its currency type. # The amount of the monthly base fee.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "eventFee": { # Represents an amount of money with its currency type. # The amount of the event fee.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "priceProtectionCredit": { # Represents an amount of money with its currency type. # The amount of the price protection credit, this is only available for eligible customers.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+    "total": { # Represents an amount of money with its currency type. # The total amount of the bill.
+      "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+      "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+      "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+    },
+  },
+  "propertyUsages": [ # Usage data for all properties in the specified organization and month.
+    { # Contains the count of events received by the property, along with metadata that influences the volume of `billable` events.
+      "accountId": "A String", # The ID of the property's parent account.
+      "billableEventCount": "A String", # The number of events for which the property is billed in the requested month.
+      "displayName": "A String", # The display name of the property.
+      "property": "A String", # The name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}
+      "propertyType": "A String", # The subtype of the analytics property. This affects the billable event count.
+      "serviceLevel": "A String", # The service level of the property.
+      "totalEventCount": "A String", # Total event count that the property received during the requested month.
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json index 4b7cb8fc40..63dc0207b5 100644 --- a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json @@ -110,6 +110,35 @@ "resources": { "organizations": { "methods": { +"findSalesPartnerManagedClients": { +"description": "Returns a list of clients managed by the sales partner organization. User needs to be an OrgAdmin/BillingAdmin on the sales partner organization in order to view the end clients.", +"flatPath": "v1alpha/organizations/{organizationsId}:findSalesPartnerManagedClients", +"httpMethod": "POST", +"id": "marketingplatformadmin.organizations.findSalesPartnerManagedClients", +"parameterOrder": [ +"organization" +], +"parameters": { +"organization": { +"description": "Required. The name of the sales partner organization. Format: organizations/{org_id}", +"location": "path", +"pattern": "^organizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+organization}:findSalesPartnerManagedClients", +"request": { +"$ref": "FindSalesPartnerManagedClientsRequest" +}, +"response": { +"$ref": "FindSalesPartnerManagedClientsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", +"https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" +] +}, "get": { "description": "Lookup for a single organization.", "flatPath": "v1alpha/organizations/{organizationsId}", @@ -135,6 +164,63 @@ "https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", "https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" ] +}, +"list": { +"description": "Returns a list of organizations that the user has access to.", +"flatPath": "v1alpha/organizations", +"httpMethod": "GET", +"id": "marketingplatformadmin.organizations.list", +"parameterOrder": [], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of organizations to return in one call. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOrganizations` must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/organizations", +"response": { +"$ref": "ListOrganizationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", +"https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" +] +}, +"reportPropertyUsage": { +"description": "Get the usage and billing data for properties within the organization for the specified month. Per direct client org, user needs to be OrgAdmin/BillingAdmin on the organization in order to view the billing and usage data. Per sales partner client org, user needs to be OrgAdmin/BillingAdmin on the sales partner org in order to view the billing and usage data, or OrgAdmin/BillingAdmin on the sales partner client org in order to view the usage data only.", +"flatPath": "v1alpha/organizations/{organizationsId}:reportPropertyUsage", +"httpMethod": "POST", +"id": "marketingplatformadmin.organizations.reportPropertyUsage", +"parameterOrder": [ +"organization" +], +"parameters": { +"organization": { +"description": "Required. Specifies the organization whose property usage will be listed. Format: organizations/{org_id}", +"location": "path", +"pattern": "^organizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+organization}:reportPropertyUsage", +"request": { +"$ref": "ReportPropertyUsageRequest" +}, +"response": { +"$ref": "ReportPropertyUsageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/marketingplatformadmin.analytics.read", +"https://www.googleapis.com/auth/marketingplatformadmin.analytics.update" +] } }, "resources": { @@ -263,7 +349,7 @@ } } }, -"revision": "20240708", +"revision": "20251029", "rootUrl": "https://marketingplatformadmin.googleapis.com/", "schemas": { "AnalyticsAccountLink": { @@ -301,12 +387,101 @@ }, "type": "object" }, +"BillInfo": { +"description": "Contains the bill amount.", +"id": "BillInfo", +"properties": { +"baseFee": { +"$ref": "Money", +"description": "The amount of the monthly base fee." +}, +"eventFee": { +"$ref": "Money", +"description": "The amount of the event fee." +}, +"priceProtectionCredit": { +"$ref": "Money", +"description": "The amount of the price protection credit, this is only available for eligible customers." +}, +"total": { +"$ref": "Money", +"description": "The total amount of the bill." +} +}, +"type": "object" +}, +"ClientData": { +"description": "Contains the client data.", +"id": "ClientData", +"properties": { +"endDate": { +"$ref": "Date", +"description": "The end date of the contract between the sales org and the end client." +}, +"organization": { +"$ref": "Organization", +"description": "The end client that has/had contract with the requested sales org." +}, +"startDate": { +"$ref": "Date", +"description": "The start date of the contract between the sales org and the end client." +} +}, +"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", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {}, "type": "object" }, +"FindSalesPartnerManagedClientsRequest": { +"description": "Request message for FindSalesPartnerManagedClients RPC.", +"id": "FindSalesPartnerManagedClientsRequest", +"properties": { +"isActive": { +"description": "Optional. If set, only active and just ended clients will be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"FindSalesPartnerManagedClientsResponse": { +"description": "Response message for FindSalesPartnerManagedClients RPC.", +"id": "FindSalesPartnerManagedClientsResponse", +"properties": { +"clientData": { +"description": "The clients managed by the sales org.", +"items": { +"$ref": "ClientData" +}, +"type": "array" +} +}, +"type": "object" +}, "ListAnalyticsAccountLinksResponse": { "description": "Response message for ListAnalyticsAccountLinks RPC.", "id": "ListAnalyticsAccountLinksResponse", @@ -325,6 +500,45 @@ }, "type": "object" }, +"ListOrganizationsResponse": { +"description": "Response message for ListOrganizations RPC.", +"id": "ListOrganizationsResponse", +"properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"organizations": { +"description": "The Organization resource that the user has access to, which includes the org id and display name.", +"items": { +"$ref": "Organization" +}, +"type": "array" +} +}, +"type": "object" +}, +"Money": { +"description": "Represents an amount of money with its currency type.", +"id": "Money", +"properties": { +"currencyCode": { +"description": "The three-letter currency code defined in ISO 4217.", +"type": "string" +}, +"nanos": { +"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", +"format": "int32", +"type": "integer" +}, +"units": { +"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Organization": { "description": "A resource message representing a Google Marketing Platform organization.", "id": "Organization", @@ -340,6 +554,95 @@ }, "type": "object" }, +"PropertyUsage": { +"description": "Contains the count of events received by the property, along with metadata that influences the volume of `billable` events.", +"id": "PropertyUsage", +"properties": { +"accountId": { +"description": "The ID of the property's parent account.", +"format": "int64", +"type": "string" +}, +"billableEventCount": { +"description": "The number of events for which the property is billed in the requested month.", +"format": "int64", +"type": "string" +}, +"displayName": { +"description": "The display name of the property.", +"type": "string" +}, +"property": { +"description": "The name of the Google Analytics Admin API property resource. Format: analyticsadmin.googleapis.com/properties/{property_id}", +"type": "string" +}, +"propertyType": { +"description": "The subtype of the analytics property. This affects the billable event count.", +"enum": [ +"ANALYTICS_PROPERTY_TYPE_UNSPECIFIED", +"ANALYTICS_PROPERTY_TYPE_ORDINARY", +"ANALYTICS_PROPERTY_TYPE_SUBPROPERTY", +"ANALYTICS_PROPERTY_TYPE_ROLLUP" +], +"enumDescriptions": [ +"Unknown or unspecified property type", +"Ordinary Google Analytics property", +"Google Analytics subproperty", +"Google Analytics rollup property" +], +"type": "string" +}, +"serviceLevel": { +"description": "The service level of the property.", +"enum": [ +"ANALYTICS_SERVICE_LEVEL_UNSPECIFIED", +"ANALYTICS_SERVICE_LEVEL_STANDARD", +"ANALYTICS_SERVICE_LEVEL_360" +], +"enumDescriptions": [ +"Service level unspecified.", +"The standard version of Google Analytics.", +"The premium version of Google Analytics." +], +"type": "string" +}, +"totalEventCount": { +"description": "Total event count that the property received during the requested month.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ReportPropertyUsageRequest": { +"description": "Request message for ReportPropertyUsage RPC.", +"id": "ReportPropertyUsageRequest", +"properties": { +"month": { +"description": "Required. The target month to list property usages. Format: YYYY-MM. For example, \"2025-05\"", +"type": "string" +} +}, +"type": "object" +}, +"ReportPropertyUsageResponse": { +"description": "Response message for ReportPropertyUsage RPC.", +"id": "ReportPropertyUsageResponse", +"properties": { +"billInfo": { +"$ref": "BillInfo", +"description": "Bill amount in the specified organization and month. Will be empty if user only has access to usage data." +}, +"propertyUsages": { +"description": "Usage data for all properties in the specified organization and month.", +"items": { +"$ref": "PropertyUsage" +}, +"type": "array" +} +}, +"type": "object" +}, "SetPropertyServiceLevelRequest": { "description": "Request message for SetPropertyServiceLevel RPC.", "id": "SetPropertyServiceLevelRequest", From 0ab905480875f3ce06881319f023d306c6ef1701 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 48/70] feat(merchantapi): update the api #### merchantapi:accounts_v1 The following keys were deleted: - resources.accounts.methods.getAccountForGcpRegistration (Total Keys: 7) The following keys were added: - resources.accounts.resources.developerRegistration.methods.getAccountForGcpRegistration (Total Keys: 7) #### merchantapi:accounts_v1beta The following keys were deleted: - resources.accounts.methods.getAccountForGcpRegistration (Total Keys: 7) The following keys were added: - resources.accounts.resources.developerRegistration.methods.getAccountForGcpRegistration (Total Keys: 7) --- ...nts_v1.accounts.developerRegistration.html | 21 ++++++++++++ .../dyn/merchantapi_accounts_v1.accounts.html | 23 +------------ ...erchantapi_accounts_v1.accounts.users.html | 12 +++---- ...v1beta.accounts.developerRegistration.html | 21 ++++++++++++ .../merchantapi_accounts_v1beta.accounts.html | 25 ++------------ ...antapi_accounts_v1beta.accounts.users.html | 12 +++---- .../documents/merchantapi.accounts_v1.json | 34 +++++++++---------- .../merchantapi.accounts_v1beta.json | 34 +++++++++---------- 8 files changed, 91 insertions(+), 91 deletions(-) diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html index 9bde300006..fc5818eb78 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getAccountForGcpRegistration(x__xgafv=None)

+

Retrieves the merchant account that the calling GCP is registered with.

getDeveloperRegistration(name, x__xgafv=None)

Retrieves a developer registration for a merchant.

@@ -92,6 +95,24 @@

Method Details

Close httplib2 connections.
+
+ getAccountForGcpRegistration(x__xgafv=None) + 
Retrieves the merchant account that the calling GCP is registered with.
+
+Args:
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the GetAccountForGcpRegistration method.
+  "name": "A String", # The name of the merchant account id that the GCP is registered with.
+}
+
+
getDeveloperRegistration(name, x__xgafv=None) 
Retrieves a developer registration for a merchant.
diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.html b/docs/dyn/merchantapi_accounts_v1.accounts.html
index cc0f16a0d6..c1a96f4b78 100644
--- a/docs/dyn/merchantapi_accounts_v1.accounts.html
+++ b/docs/dyn/merchantapi_accounts_v1.accounts.html
@@ -176,9 +176,6 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

-

-  getAccountForGcpRegistration(x__xgafv=None)

-
Retrieves the merchant account that the calling GCP is registered with.

 

   list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.

@@ -230,7 +227,7 @@ 
Method Details

   ],
   "user": [ # Optional. Users to be added to the account.
     { # Instruction for adding a user to the account during creation.
-      "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. Details about the user to be added. At the moment, only access rights may be specified.
+      "user": { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. Details about the user to be added. At the moment, only access rights may be specified.
         "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
           "A String",
         ],
@@ -311,24 +308,6 @@ 
Method Details

 }
-
- getAccountForGcpRegistration(x__xgafv=None) - 
Retrieves the merchant account that the calling GCP is registered with.
-
-Args:
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for the GetAccountForGcpRegistration method.
-  "name": "A String", # The name of the merchant account id that the GCP is registered with.
-}
-
-
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) 
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.users.html b/docs/dyn/merchantapi_accounts_v1.accounts.users.html
index f3aac4d59a..6893adeb9e 100644
--- a/docs/dyn/merchantapi_accounts_v1.accounts.users.html
+++ b/docs/dyn/merchantapi_accounts_v1.accounts.users.html
@@ -110,7 +110,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -127,7 +127,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -168,7 +168,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -196,7 +196,7 @@ 
Method Details

     { # Response message for the `ListUsers` method.
   "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
   "users": [ # The users from the specified account.
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
       "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
         "A String",
       ],
@@ -230,7 +230,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -247,7 +247,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html
index d429e7f771..794c2f822d 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.developerRegistration.html
@@ -77,6 +77,9 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  getAccountForGcpRegistration(x__xgafv=None)

+
Retrieves the merchant account that the calling GCP is registered with.

 

   getDeveloperRegistration(name, x__xgafv=None)

 
Retrieves a developer registration for a merchant.

@@ -92,6 +95,24 @@ 
Method Details

   
Close httplib2 connections.
+
+ getAccountForGcpRegistration(x__xgafv=None) + 
Retrieves the merchant account that the calling GCP is registered with.
+
+Args:
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the GetAccountForGcpRegistration method.
+  "name": "A String", # The name of the merchant account id that the GCP is registered with.
+}
+
+
getDeveloperRegistration(name, x__xgafv=None) 
Retrieves a developer registration for a merchant.
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
index b1067f68aa..e1b8640c8e 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html
@@ -176,9 +176,6 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

-

-  getAccountForGcpRegistration(x__xgafv=None)

-
Retrieves the merchant account that the calling GCP is registered with.

 

   list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.

@@ -230,7 +227,7 @@ 
Method Details

   ],
   "user": [ # Optional. Users to be added to the account.
     { # Instruction for adding a user to the account during creation.
-      "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. Details about the user to be added. At the moment, only access rights may be specified.
+      "user": { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. Details about the user to be added. At the moment, only access rights may be specified.
         "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
           "A String",
         ],
@@ -243,7 +240,7 @@ 
Method Details

   "users": [ # Optional. Users to be added to the account. This field is deprecated and will not exist after the API evolves out of beta. Use the `user` field instead.
     { # Request message for the `CreateUser` method.
       "parent": "A String", # Required. The resource name of the account for which a user will be created. Format: `accounts/{account}`
-      "user": { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. The user to create.
+      "user": { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. The user to create.
         "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
           "A String",
         ],
@@ -324,24 +321,6 @@ 
Method Details

 }
-
- getAccountForGcpRegistration(x__xgafv=None) - 
Retrieves the merchant account that the calling GCP is registered with.
-
-Args:
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for the GetAccountForGcpRegistration method.
-  "name": "A String", # The name of the merchant account id that the GCP is registered with.
-}
-
-
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) 
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html
index e1a562df08..f82fdbd13b 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html
@@ -110,7 +110,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -127,7 +127,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -168,7 +168,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -196,7 +196,7 @@ 
Method Details

     { # Response message for the `ListUsers` method.
   "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
   "users": [ # The users from the specified account.
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
       "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
         "A String",
       ],
@@ -230,7 +230,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
@@ -247,7 +247,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
+    { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).
   "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.
     "A String",
   ],
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json
index 72b4d9f983..98f9ad1ac8 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json
@@ -180,21 +180,6 @@
 "https://www.googleapis.com/auth/content"
 ]
 },
-"getAccountForGcpRegistration": {
-"description": "Retrieves the merchant account that the calling GCP is registered with.",
-"flatPath": "accounts/v1/accounts:getAccountForGcpRegistration",
-"httpMethod": "GET",
-"id": "merchantapi.accounts.getAccountForGcpRegistration",
-"parameterOrder": [],
-"parameters": {},
-"path": "accounts/v1/accounts:getAccountForGcpRegistration",
-"response": {
-"$ref": "GetAccountForGcpRegistrationResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/content"
-]
-},
 "list": {
 "description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.",
 "flatPath": "accounts/v1/accounts",
@@ -553,6 +538,21 @@
 },
 "developerRegistration": {
 "methods": {
+"getAccountForGcpRegistration": {
+"description": "Retrieves the merchant account that the calling GCP is registered with.",
+"flatPath": "accounts/v1/accounts:getAccountForGcpRegistration",
+"httpMethod": "GET",
+"id": "merchantapi.accounts.developerRegistration.getAccountForGcpRegistration",
+"parameterOrder": [],
+"parameters": {},
+"path": "accounts/v1/accounts:getAccountForGcpRegistration",
+"response": {
+"$ref": "GetAccountForGcpRegistrationResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/content"
+]
+},
 "getDeveloperRegistration": {
 "description": "Retrieves a developer registration for a merchant.",
 "flatPath": "accounts/v1/accounts/{accountsId}/developerRegistration",
@@ -2376,7 +2376,7 @@
 }
 }
 },
-"revision": "20251002",
+"revision": "20251023",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "About": {
@@ -5455,7 +5455,7 @@ false
 "type": "object"
 },
 "User": {
-"description": "The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).",
+"description": "The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).",
 "id": "User",
 "properties": {
 "accessRights": {
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
index 2726b47b3c..8b3b5bef23 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json
@@ -180,21 +180,6 @@
 "https://www.googleapis.com/auth/content"
 ]
 },
-"getAccountForGcpRegistration": {
-"description": "Retrieves the merchant account that the calling GCP is registered with.",
-"flatPath": "accounts/v1beta/accounts:getAccountForGcpRegistration",
-"httpMethod": "GET",
-"id": "merchantapi.accounts.getAccountForGcpRegistration",
-"parameterOrder": [],
-"parameters": {},
-"path": "accounts/v1beta/accounts:getAccountForGcpRegistration",
-"response": {
-"$ref": "GetAccountForGcpRegistrationResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/content"
-]
-},
 "list": {
 "description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.",
 "flatPath": "accounts/v1beta/accounts",
@@ -553,6 +538,21 @@
 },
 "developerRegistration": {
 "methods": {
+"getAccountForGcpRegistration": {
+"description": "Retrieves the merchant account that the calling GCP is registered with.",
+"flatPath": "accounts/v1beta/accounts:getAccountForGcpRegistration",
+"httpMethod": "GET",
+"id": "merchantapi.accounts.developerRegistration.getAccountForGcpRegistration",
+"parameterOrder": [],
+"parameters": {},
+"path": "accounts/v1beta/accounts:getAccountForGcpRegistration",
+"response": {
+"$ref": "GetAccountForGcpRegistrationResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/content"
+]
+},
 "getDeveloperRegistration": {
 "description": "Retrieves a developer registration for a merchant.",
 "flatPath": "accounts/v1beta/accounts/{accountsId}/developerRegistration",
@@ -2326,7 +2326,7 @@
 }
 }
 },
-"revision": "20251002",
+"revision": "20251023",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "About": {
@@ -5316,7 +5316,7 @@ false
 "type": "object"
 },
 "User": {
-"description": "The `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).",
+"description": "The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).",
 "id": "User",
 "properties": {
 "accessRights": {

From 78e75ea60e9826f042cdae50ea1e380caded402f Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:15 +0000
Subject: [PATCH 49/70] feat(migrationcenter): update the api

#### migrationcenter:v1alpha1

The following keys were deleted:
- schemas.AssetsExportJobNetworkDependencies.properties.maxDays (Total Keys: 2)

The following keys were added:
- schemas.Asset.properties.awsDynamodbTableDetails (Total Keys: 2)
- schemas.Asset.properties.awsNatGatewayDetails (Total Keys: 2)
- schemas.Asset.properties.awsRoute53HostedZoneDetails (Total Keys: 2)
- schemas.AssetFrame.properties.awsDynamodbTableDetails.$ref (Total Keys: 1)
- schemas.AssetFrame.properties.awsNatGatewayDetails.$ref (Total Keys: 1)
- schemas.AssetFrame.properties.awsRoute53HostedZoneDetails.$ref (Total Keys: 1)
- schemas.AwsDynamoDBTableDetails (Total Keys: 2)
- schemas.AwsNatGatewayDetails (Total Keys: 2)
- schemas.AwsRoute53HostedZoneDetails (Total Keys: 2)
---
 ...migrationcenter_v1.projects.locations.html |  2 +-
 ...er_v1alpha1.projects.locations.assets.html | 42 ++++++++++++++
 ...1.projects.locations.assetsExportJobs.html |  3 -
 ...ioncenter_v1alpha1.projects.locations.html |  2 +-
 ...rojects.locations.sources.errorFrames.html | 12 ++++
 .../documents/migrationcenter.v1.json         |  4 +-
 .../documents/migrationcenter.v1alpha1.json   | 57 ++++++++++++++++---
 7 files changed, 106 insertions(+), 16 deletions(-)

diff --git a/docs/dyn/migrationcenter_v1.projects.locations.html b/docs/dyn/migrationcenter_v1.projects.locations.html
index 888a9f8ab5..634c3d54e0 100644
--- a/docs/dyn/migrationcenter_v1.projects.locations.html
+++ b/docs/dyn/migrationcenter_v1.projects.locations.html
@@ -197,7 +197,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
index 529fd11b68..a583f69c0e 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
@@ -227,6 +227,8 @@ 
Method Details

         },
         "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions.
         },
+        "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables.
+        },
         "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters.
         },
         "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems.
@@ -237,8 +239,12 @@ 
Method Details

         },
         "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions.
         },
+        "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails
+        },
         "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Output only. Asset information specific for AWS Redshift
         },
+        "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Output only. Asset information specific for AwsRoute53HostedZoneDetails
+        },
         "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Output only. Asset information specific for AWS S3 buckets.
           "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
             "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -1285,6 +1291,8 @@ 
Method Details

       },
       "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions.
       },
+      "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables.
+      },
       "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters.
       },
       "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems.
@@ -1295,8 +1303,12 @@ 
Method Details

       },
       "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions.
       },
+      "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails
+      },
       "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Output only. Asset information specific for AWS Redshift
       },
+      "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Output only. Asset information specific for AwsRoute53HostedZoneDetails
+      },
       "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Output only. Asset information specific for AWS S3 buckets.
         "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
           "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -2375,6 +2387,8 @@ 
Method Details

   },
   "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions.
   },
+  "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables.
+  },
   "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters.
   },
   "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems.
@@ -2385,8 +2399,12 @@ 
Method Details

   },
   "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions.
   },
+  "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails
+  },
   "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Output only. Asset information specific for AWS Redshift
   },
+  "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Output only. Asset information specific for AwsRoute53HostedZoneDetails
+  },
   "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Output only. Asset information specific for AWS S3 buckets.
     "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
       "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -3446,6 +3464,8 @@ 
Method Details

       },
       "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions.
       },
+      "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables.
+      },
       "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters.
       },
       "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems.
@@ -3456,8 +3476,12 @@ 
Method Details

       },
       "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions.
       },
+      "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails
+      },
       "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Output only. Asset information specific for AWS Redshift
       },
+      "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Output only. Asset information specific for AwsRoute53HostedZoneDetails
+      },
       "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Output only. Asset information specific for AWS S3 buckets.
         "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
           "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -4519,6 +4543,8 @@ 
Method Details

   },
   "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions.
   },
+  "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables.
+  },
   "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters.
   },
   "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems.
@@ -4529,8 +4555,12 @@ 
Method Details

   },
   "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions.
   },
+  "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails
+  },
   "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Output only. Asset information specific for AWS Redshift
   },
+  "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Output only. Asset information specific for AwsRoute53HostedZoneDetails
+  },
   "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Output only. Asset information specific for AWS S3 buckets.
     "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
       "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -5572,6 +5602,8 @@ 
Method Details

   },
   "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Output only. Asset information specific for AWS CloudFront distributions.
   },
+  "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Output only. Asset information specific for AWS DynamoDB tables.
+  },
   "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Output only. Asset information specific for AWS ECS clusters.
   },
   "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Output only. Asset information specific for AWS EFS file systems.
@@ -5582,8 +5614,12 @@ 
Method Details

   },
   "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Output only. Asset information specific for AWS Lambda functions.
   },
+  "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Output only. Asset information specific for AwsNatGatewayDetails
+  },
   "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Output only. Asset information specific for AWS Redshift
   },
+  "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Output only. Asset information specific for AwsRoute53HostedZoneDetails
+  },
   "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Output only. Asset information specific for AWS S3 buckets.
     "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
       "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -6624,6 +6660,8 @@ 
Method Details

       },
       "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Asset information specific for AWS CloudFront distributions.
       },
+      "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Asset information specific for AWS DynamoDB tables.
+      },
       "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Asset information specific for AWS ECS clusters.
       },
       "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Asset information specific for AWS EFS file systems.
@@ -6634,8 +6672,12 @@ 
Method Details

       },
       "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Asset information specific for AWS Lambda functions.
       },
+      "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Asset information specific for AwsNatGatewayDetails
+      },
       "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Asset information specific for AWS Redshift clusters.
       },
+      "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Asset information specific for AwsRoute53HostedZoneDetails
+      },
       "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Asset information specific for AWS S3 buckets.
         "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
           "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html
index 7134397da9..13c50f5ce8 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assetsExportJobs.html
@@ -122,7 +122,6 @@ 
Method Details

   },
   "name": "A String", # Output only. Identifier. Resource name.
   "networkDependencies": { # Configuration for network dependencies exports. # Export data regarding asset network dependencies.
-    "maxDays": 42, # Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned.
   },
   "performanceData": { # Configuration for performance data exports. # Export asset with performance data.
     "maxDays": 42, # Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used.
@@ -275,7 +274,6 @@ 
Method Details

   },
   "name": "A String", # Output only. Identifier. Resource name.
   "networkDependencies": { # Configuration for network dependencies exports. # Export data regarding asset network dependencies.
-    "maxDays": 42, # Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned.
   },
   "performanceData": { # Configuration for performance data exports. # Export asset with performance data.
     "maxDays": 42, # Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used.
@@ -367,7 +365,6 @@ 
Method Details

       },
       "name": "A String", # Output only. Identifier. Resource name.
       "networkDependencies": { # Configuration for network dependencies exports. # Export data regarding asset network dependencies.
-        "maxDays": 42, # Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned.
       },
       "performanceData": { # Configuration for performance data exports. # Export asset with performance data.
         "maxDays": 42, # Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used.
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.html
index 09033c2535..9f96ea438b 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.html
@@ -203,7 +203,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
index 785b613192..adb4c71a98 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
@@ -120,6 +120,8 @@ 
Method Details

     },
     "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Asset information specific for AWS CloudFront distributions.
     },
+    "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Asset information specific for AWS DynamoDB tables.
+    },
     "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Asset information specific for AWS ECS clusters.
     },
     "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Asset information specific for AWS EFS file systems.
@@ -130,8 +132,12 @@ 
Method Details

     },
     "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Asset information specific for AWS Lambda functions.
     },
+    "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Asset information specific for AwsNatGatewayDetails
+    },
     "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Asset information specific for AWS Redshift clusters.
     },
+    "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Asset information specific for AwsRoute53HostedZoneDetails
+    },
     "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Asset information specific for AWS S3 buckets.
       "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
         "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
@@ -1045,6 +1051,8 @@ 
Method Details

         },
         "awsCloudFrontDistributionDetails": { # Details of an AWS CloudFront distribution. # Asset information specific for AWS CloudFront distributions.
         },
+        "awsDynamodbTableDetails": { # Details of an AWS DynamoDB table. # Asset information specific for AWS DynamoDB tables.
+        },
         "awsEcsClusterDetails": { # Details of an AWS ECS cluster. # Asset information specific for AWS ECS clusters.
         },
         "awsEfsFileSystemDetails": { # Details of an AWS EFS file system. # Asset information specific for AWS EFS file systems.
@@ -1055,8 +1063,12 @@ 
Method Details

         },
         "awsLambdaFunctionDetails": { # Asset information specific for AWS Lambda functions. # Asset information specific for AWS Lambda functions.
         },
+        "awsNatGatewayDetails": { # Details of an AWS NAT Gateway. # Asset information specific for AwsNatGatewayDetails
+        },
         "awsRedshiftDetails": { # Details of an AWS Redshift cluster. # Asset information specific for AWS Redshift clusters.
         },
+        "awsRoute53HostedZoneDetails": { # Details of an AWS Route 53 Hosted Zone. # Asset information specific for AwsRoute53HostedZoneDetails
+        },
         "awsS3BucketDetails": { # Asset information specific for AWS S3 buckets. # Asset information specific for AWS S3 buckets.
           "objectsMetadata": { # The metadata of the objects in the bucket. # Optional. The metadata of the objects in the bucket.
             "totalObjects": { # Information about the total number of objects in the bucket. # Optional. The total number of objects in the bucket.
diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json
index 2b51a4ede6..31ed10603a 100644
--- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json
+++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json
@@ -169,7 +169,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2412,7 +2412,7 @@
 }
 }
 },
-"revision": "20250930",
+"revision": "20251023",
 "rootUrl": "https://migrationcenter.googleapis.com/",
 "schemas": {
 "AddAssetsToGroupRequest": {
diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
index 5537f9c0af..16d3b4177d 100644
--- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
@@ -169,7 +169,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2559,7 +2559,7 @@
 }
 }
 },
-"revision": "20250930",
+"revision": "20251023",
 "rootUrl": "https://migrationcenter.googleapis.com/",
 "schemas": {
 "AddAssetsToGroupRequest": {
@@ -2795,6 +2795,11 @@
 "description": "Output only. Asset information specific for AWS CloudFront distributions.",
 "readOnly": true
 },
+"awsDynamodbTableDetails": {
+"$ref": "AwsDynamoDBTableDetails",
+"description": "Output only. Asset information specific for AWS DynamoDB tables.",
+"readOnly": true
+},
 "awsEcsClusterDetails": {
 "$ref": "AwsEcsClusterDetails",
 "description": "Output only. Asset information specific for AWS ECS clusters.",
@@ -2820,11 +2825,21 @@
 "description": "Output only. Asset information specific for AWS Lambda functions.",
 "readOnly": true
 },
+"awsNatGatewayDetails": {
+"$ref": "AwsNatGatewayDetails",
+"description": "Output only. Asset information specific for AwsNatGatewayDetails",
+"readOnly": true
+},
 "awsRedshiftDetails": {
 "$ref": "AwsRedshiftDetails",
 "description": "Output only. Asset information specific for AWS Redshift",
 "readOnly": true
 },
+"awsRoute53HostedZoneDetails": {
+"$ref": "AwsRoute53HostedZoneDetails",
+"description": "Output only. Asset information specific for AwsRoute53HostedZoneDetails",
+"readOnly": true
+},
 "awsS3BucketDetails": {
 "$ref": "AwsS3BucketDetails",
 "description": "Output only. Asset information specific for AWS S3 buckets.",
@@ -2946,6 +2961,10 @@
 "$ref": "AwsCloudFrontDistributionDetails",
 "description": "Asset information specific for AWS CloudFront distributions."
 },
+"awsDynamodbTableDetails": {
+"$ref": "AwsDynamoDBTableDetails",
+"description": "Asset information specific for AWS DynamoDB tables."
+},
 "awsEcsClusterDetails": {
 "$ref": "AwsEcsClusterDetails",
 "description": "Asset information specific for AWS ECS clusters."
@@ -2966,10 +2985,18 @@
 "$ref": "AwsLambdaFunctionDetails",
 "description": "Asset information specific for AWS Lambda functions."
 },
+"awsNatGatewayDetails": {
+"$ref": "AwsNatGatewayDetails",
+"description": "Asset information specific for AwsNatGatewayDetails"
+},
 "awsRedshiftDetails": {
 "$ref": "AwsRedshiftDetails",
 "description": "Asset information specific for AWS Redshift clusters."
 },
+"awsRoute53HostedZoneDetails": {
+"$ref": "AwsRoute53HostedZoneDetails",
+"description": "Asset information specific for AwsRoute53HostedZoneDetails"
+},
 "awsS3BucketDetails": {
 "$ref": "AwsS3BucketDetails",
 "description": "Asset information specific for AWS S3 buckets."
@@ -3226,13 +3253,7 @@
 "AssetsExportJobNetworkDependencies": {
 "description": "Configuration for network dependencies exports.",
 "id": "AssetsExportJobNetworkDependencies",
-"properties": {
-"maxDays": {
-"description": "Optional. When this value is set to a positive integer, network connections data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned.",
-"format": "int32",
-"type": "integer"
-}
-},
+"properties": {},
 "type": "object"
 },
 "AssetsExportJobPerformanceData": {
@@ -3253,6 +3274,12 @@
 "properties": {},
 "type": "object"
 },
+"AwsDynamoDBTableDetails": {
+"description": "Details of an AWS DynamoDB table.",
+"id": "AwsDynamoDBTableDetails",
+"properties": {},
+"type": "object"
+},
 "AwsEc2PlatformDetails": {
 "description": "AWS EC2 specific details.",
 "id": "AwsEc2PlatformDetails",
@@ -3312,6 +3339,12 @@
 "properties": {},
 "type": "object"
 },
+"AwsNatGatewayDetails": {
+"description": "Details of an AWS NAT Gateway.",
+"id": "AwsNatGatewayDetails",
+"properties": {},
+"type": "object"
+},
 "AwsRds": {
 "description": "Specific details for an AWS RDS database deployment.",
 "id": "AwsRds",
@@ -3324,6 +3357,12 @@
 "properties": {},
 "type": "object"
 },
+"AwsRoute53HostedZoneDetails": {
+"description": "Details of an AWS Route 53 Hosted Zone.",
+"id": "AwsRoute53HostedZoneDetails",
+"properties": {},
+"type": "object"
+},
 "AwsS3BucketDetails": {
 "description": "Asset information specific for AWS S3 buckets.",
 "id": "AwsS3BucketDetails",

From 3c5aec787252d590708a242ed163aee783db352d Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:15 +0000
Subject: [PATCH 50/70] feat(networkservices): update the api

#### networkservices:v1

The following keys were added:
- resources.projects.resources.locations.resources.lbEdgeExtensions.methods.create (Total Keys: 16)
- resources.projects.resources.locations.resources.lbEdgeExtensions.methods.delete (Total Keys: 13)
- resources.projects.resources.locations.resources.lbEdgeExtensions.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.lbEdgeExtensions.methods.list (Total Keys: 20)
- resources.projects.resources.locations.resources.lbEdgeExtensions.methods.patch (Total Keys: 17)
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ExtensionChainExtension.properties.requestBodySendMode.type (Total Keys: 1)
- schemas.ExtensionChainExtension.properties.responseBodySendMode.type (Total Keys: 1)
- schemas.LbEdgeExtension (Total Keys: 16)
- schemas.ListLbEdgeExtensionsResponse (Total Keys: 7)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)

#### networkservices:v1beta1

The following keys were added:
- resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
---
 ...networkservices_v1.projects.locations.html |   7 +-
 ...1.projects.locations.lbEdgeExtensions.html | 444 ++++++++++++++++++
 ....projects.locations.lbRouteExtensions.html |  32 +-
 ...rojects.locations.lbTrafficExtensions.html |  32 +-
 ...ices_v1.projects.locations.operations.html |   8 +-
 ...rkservices_v1beta1.projects.locations.html |   2 +-
 ...1.projects.locations.lbEdgeExtensions.html |  40 +-
 ....projects.locations.lbRouteExtensions.html |  40 +-
 ...a1.projects.locations.lbTcpExtensions.html |  40 +-
 ...rojects.locations.lbTrafficExtensions.html |  40 +-
 ...v1beta1.projects.locations.operations.html |   8 +-
 .../documents/networkservices.v1.json         | 325 ++++++++++++-
 .../documents/networkservices.v1beta1.json    |  32 +-
 13 files changed, 920 insertions(+), 130 deletions(-)
 create mode 100644 docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html

diff --git a/docs/dyn/networkservices_v1.projects.locations.html b/docs/dyn/networkservices_v1.projects.locations.html
index 94e2950393..aee2f5df01 100644
--- a/docs/dyn/networkservices_v1.projects.locations.html
+++ b/docs/dyn/networkservices_v1.projects.locations.html
@@ -114,6 +114,11 @@ 
Instance Methods

 

 
Returns the httpRoutes Resource.

 
+

+  lbEdgeExtensions()
+

+
Returns the lbEdgeExtensions Resource.

+
 

   lbRouteExtensions()
 

@@ -210,7 +215,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html
new file mode 100644
index 0000000000..cce3a5c142
--- /dev/null
+++ b/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html
@@ -0,0 +1,444 @@
+
+
+
+
Network Services API . projects . locations . lbEdgeExtensions

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  create(parent, body=None, lbEdgeExtensionId=None, requestId=None, x__xgafv=None)

+
Creates a new `LbEdgeExtension` resource in a given project and location.

+

+  delete(name, requestId=None, x__xgafv=None)

+
Deletes the specified `LbEdgeExtension` resource.

+

+  get(name, x__xgafv=None)

+
Gets details of the specified `LbEdgeExtension` resource.

+

+  list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists `LbEdgeExtension` resources in a given project and location.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+
Updates the parameters of the specified `LbEdgeExtension` resource.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    create(parent, body=None, lbEdgeExtensionId=None, requestId=None, x__xgafv=None)
+  
Creates a new `LbEdgeExtension` resource in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
+    { # A single extension chain wrapper that contains the match conditions and extensions to execute.
+      "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain.
+        { # A single extension in the chain to execute for the matching request.
+          "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+          "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.
+          "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
+            "A String",
+          ],
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+            "a_key": "", # Properties of the object.
+          },
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
+          "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
+            "A String",
+          ],
+          "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+        },
+      ],
+      "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request.
+        "celExpression": "A String", # Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
+      },
+      "name": "A String", # Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+    },
+  ],
+  "forwardingRules": [ # Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.
+    "A String",
+  ],
+  "labels": { # Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.
+    "a_key": "A String",
+  },
+  "loadBalancingScheme": "A String", # Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`.
+  "name": "A String", # Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  lbEdgeExtensionId: string, Required. User-provided ID of the `LbEdgeExtension` resource to be created.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    delete(name, requestId=None, x__xgafv=None)
+  
Deletes the specified `LbEdgeExtension` resource.
+
+Args:
+  name: string, Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets details of the specified `LbEdgeExtension` resource.
+
+Args:
+  name: string, Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
+    { # A single extension chain wrapper that contains the match conditions and extensions to execute.
+      "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain.
+        { # A single extension in the chain to execute for the matching request.
+          "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+          "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.
+          "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
+            "A String",
+          ],
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+            "a_key": "", # Properties of the object.
+          },
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
+          "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
+            "A String",
+          ],
+          "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+        },
+      ],
+      "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request.
+        "celExpression": "A String", # Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
+      },
+      "name": "A String", # Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+    },
+  ],
+  "forwardingRules": [ # Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.
+    "A String",
+  ],
+  "labels": { # Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.
+    "a_key": "A String",
+  },
+  "loadBalancingScheme": "A String", # Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`.
+  "name": "A String", # Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}

+

+
+

+    list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists `LbEdgeExtension` resources in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`. (required)
+  filter: string, Optional. Filtering results.
+  orderBy: string, Optional. Hint about how to order the results.
+  pageSize: integer, Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results that the server returns.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing `LbEdgeExtension` resources.
+  "lbEdgeExtensions": [ # The list of `LbEdgeExtension` resources.
+    { # `LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
+        { # A single extension chain wrapper that contains the match conditions and extensions to execute.
+          "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain.
+            { # A single extension in the chain to execute for the matching request.
+              "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+              "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.
+              "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
+                "A String",
+              ],
+              "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+                "a_key": "", # Properties of the object.
+              },
+              "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+              "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+              "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
+              "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
+              "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
+                "A String",
+              ],
+              "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+            },
+          ],
+          "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request.
+            "celExpression": "A String", # Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
+          },
+          "name": "A String", # Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+        },
+      ],
+      "forwardingRules": [ # Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.
+        "A String",
+      ],
+      "labels": { # Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.
+        "a_key": "A String",
+      },
+      "loadBalancingScheme": "A String", # Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`.
+      "name": "A String", # Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results that the server returns.
+  "unreachable": [ # Locations that could not be reached.
+    "A String",
+  ],
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
+  
Updates the parameters of the specified `LbEdgeExtension` resource.
+
+Args:
+  name: string, Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.
+    { # A single extension chain wrapper that contains the match conditions and extensions to execute.
+      "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain.
+        { # A single extension in the chain to execute for the matching request.
+          "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+          "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.
+          "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
+            "A String",
+          ],
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+            "a_key": "", # Properties of the object.
+          },
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
+          "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
+            "A String",
+          ],
+          "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
+        },
+      ],
+      "matchCondition": { # Conditions under which this chain is invoked for a request. # Required. Conditions under which this chain is invoked for a request.
+        "celExpression": "A String", # Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. For more information, see [CEL matcher language reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
+      },
+      "name": "A String", # Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+    },
+  ],
+  "forwardingRules": [ # Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.
+    "A String",
+  ],
+  "labels": { # Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.
+    "a_key": "A String",
+  },
+  "loadBalancingScheme": "A String", # Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`.
+  "name": "A String", # Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html
index 8fcddf8295..f2aa53fb51 100644
--- a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html
+++ b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html
@@ -122,12 +122,14 @@ 
Method Details

           "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
             "A String",
           ],
-          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
             "a_key": "", # Properties of the object.
           },
-          "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
           "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
             "A String",
           ],
           "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
@@ -246,12 +248,14 @@ 
Method Details

           "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
             "A String",
           ],
-          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
             "a_key": "", # Properties of the object.
           },
-          "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
           "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
             "A String",
           ],
           "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
@@ -310,12 +314,14 @@ 
Method Details

               "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
                 "A String",
               ],
-              "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+              "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
                 "a_key": "", # Properties of the object.
               },
-              "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+              "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+              "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+              "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
               "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-              "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+              "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
                 "A String",
               ],
               "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
@@ -383,12 +389,14 @@ 
Method Details

           "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
             "A String",
           ],
-          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
             "a_key": "", # Properties of the object.
           },
-          "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
           "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
             "A String",
           ],
           "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
diff --git a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html
index 1a8d325346..34043d5294 100644
--- a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html
+++ b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html
@@ -122,12 +122,14 @@ 
Method Details

           "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
             "A String",
           ],
-          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
             "a_key": "", # Properties of the object.
           },
-          "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
           "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
             "A String",
           ],
           "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
@@ -246,12 +248,14 @@ 
Method Details

           "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
             "A String",
           ],
-          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
             "a_key": "", # Properties of the object.
           },
-          "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
           "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
             "A String",
           ],
           "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
@@ -310,12 +314,14 @@ 
Method Details

               "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
                 "A String",
               ],
-              "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+              "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
                 "a_key": "", # Properties of the object.
               },
-              "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+              "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+              "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+              "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
               "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-              "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+              "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
                 "A String",
               ],
               "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
@@ -383,12 +389,14 @@ 
Method Details

           "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.
             "A String",
           ],
-          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
+          "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.
             "a_key": "", # Properties of the object.
           },
-          "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.
+          "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.
+          "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.
+          "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.
           "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources.
-          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.
+          "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.
             "A String",
           ],
           "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error.
diff --git a/docs/dyn/networkservices_v1.projects.locations.operations.html b/docs/dyn/networkservices_v1.projects.locations.operations.html
index ea2e521c7a..3bace089b2 100644
--- a/docs/dyn/networkservices_v1.projects.locations.operations.html
+++ b/docs/dyn/networkservices_v1.projects.locations.operations.html
@@ -87,7 +87,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

 

   list_next()

@@ -176,7 +176,7 @@ 
Method Details
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.html b/docs/dyn/networkservices_v1beta1.projects.locations.html index d6c8495964..2545b42e05 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.html @@ -205,7 +205,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html index 0f1f1e5f03..6ba9e619b4 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html @@ -117,20 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -241,20 +241,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -305,20 +305,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -378,20 +378,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html index d2fa7f7c54..9c0be859c5 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html @@ -117,20 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -244,20 +244,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -311,20 +311,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -387,20 +387,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html index 94223276b8..f56c9e606c 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html @@ -117,20 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -241,20 +241,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -305,20 +305,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -378,20 +378,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html index 6febc8604a..243f4121d9 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html @@ -117,20 +117,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -244,20 +244,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -311,20 +311,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -387,20 +387,20 @@

Method Details

{ # A single extension chain wrapper that contains the match conditions and extensions to execute. "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` and `LbEdgeExtension` chains are limited to 1 extension per extension chain. { # A single extension in the chain to execute for the matching request. - "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error. + "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. "forwardHeaders": [ # Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. "A String", ], - "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. + "metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings. "a_key": "", # Properties of the object. }, - "name": "A String", # Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + "name": "A String", # Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. - "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. + "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, and the `LbEdgeExtension` resources. - "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. + "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. "A String", ], "timeout": "A String", # Optional. Specifies the timeout for each individual message on the stream. The timeout must be between `10`-`10000` milliseconds. Required for callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.operations.html b/docs/dyn/networkservices_v1beta1.projects.locations.operations.html index e6a78db62e..c04d7f5965 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.operations.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 793e96d474..6955d92c22 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1348,6 +1348,188 @@ } } }, +"lbEdgeExtensions": { +"methods": { +"create": { +"description": "Creates a new `LbEdgeExtension` resource in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.lbEdgeExtensions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"lbEdgeExtensionId": { +"description": "Required. User-provided ID of the `LbEdgeExtension` resource to be created.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the `LbEdgeExtension` resource. Must be in the format `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/lbEdgeExtensions", +"request": { +"$ref": "LbEdgeExtension" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes the specified `LbEdgeExtension` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", +"httpMethod": "DELETE", +"id": "networkservices.projects.locations.lbEdgeExtensions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the `LbEdgeExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of the specified `LbEdgeExtension` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", +"httpMethod": "GET", +"id": "networkservices.projects.locations.lbEdgeExtensions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `LbEdgeExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "LbEdgeExtension" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists `LbEdgeExtension` resources in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions", +"httpMethod": "GET", +"id": "networkservices.projects.locations.lbEdgeExtensions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint about how to order the results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results that the server returns.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the `LbEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/lbEdgeExtensions", +"response": { +"$ref": "ListLbEdgeExtensionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of the specified `LbEdgeExtension` resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/lbEdgeExtensions/{lbEdgeExtensionsId}", +"httpMethod": "PATCH", +"id": "networkservices.projects.locations.lbEdgeExtensions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/lbEdgeExtensions/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Used to specify the fields to be overwritten in the `LbEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "LbEdgeExtension" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "lbRouteExtensions": { "methods": { "create": { @@ -2052,6 +2234,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3004,7 +3191,7 @@ } } }, -"revision": "20250723", +"revision": "20251017", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3136,13 +3323,11 @@ "description": "Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.", "enum": [ "WIRE_FORMAT_UNSPECIFIED", -"EXT_PROC_GRPC", -"EXT_AUTHZ_GRPC" +"EXT_PROC_GRPC" ], "enumDescriptions": [ "Not specified.", -"The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream.", -"The extension service uses Envoy's `ext_authz` gRPC API. The backend service for the extension must use HTTP2, or H2C as the protocol. `EXT_AUTHZ_GRPC` is only supported for `AuthzExtension` resources." +"The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream." ], "type": "string" } @@ -3374,11 +3559,39 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", +"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", "type": "object" }, "name": { -"description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", +"description": "Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.", +"type": "string" +}, +"requestBodySendMode": { +"description": "Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources.", +"enum": [ +"BODY_SEND_MODE_UNSPECIFIED", +"BODY_SEND_MODE_STREAMED", +"BODY_SEND_MODE_FULL_DUPLEX_STREAMED" +], +"enumDescriptions": [ +"Default value. Do not use.", +"Calls to the extension are executed in the streamed mode. Subsequent chunks will be sent only after the previous chunks have been processed. The content of the body chunks is sent one way to the extension. Extension may send modified chunks back. This is the default value if the processing mode is not specified.", +"Calls are executed in the full duplex mode. Subsequent chunks will be sent for processing without waiting for the response for the previous chunk or for the response for `REQUEST_HEADERS` event. Extension can freely modify or chunk the body contents. If the extension doesn't send the body contents back, the next extension in the chain or the upstream will receive an empty body." +], +"type": "string" +}, +"responseBodySendMode": { +"description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", +"enum": [ +"BODY_SEND_MODE_UNSPECIFIED", +"BODY_SEND_MODE_STREAMED", +"BODY_SEND_MODE_FULL_DUPLEX_STREAMED" +], +"enumDescriptions": [ +"Default value. Do not use.", +"Calls to the extension are executed in the streamed mode. Subsequent chunks will be sent only after the previous chunks have been processed. The content of the body chunks is sent one way to the extension. Extension may send modified chunks back. This is the default value if the processing mode is not specified.", +"Calls are executed in the full duplex mode. Subsequent chunks will be sent for processing without waiting for the response for the previous chunk or for the response for `REQUEST_HEADERS` event. Extension can freely modify or chunk the body contents. If the extension doesn't send the body contents back, the next extension in the chain or the upstream will receive an empty body." +], "type": "string" }, "service": { @@ -3386,7 +3599,7 @@ "type": "string" }, "supportedEvents": { -"description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.", +"description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.", "items": { "enum": [ "EVENT_TYPE_UNSPECIFIED", @@ -4454,6 +4667,68 @@ }, "type": "object" }, +"LbEdgeExtension": { +"description": "`LbEdgeExtension` is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.", +"id": "LbEdgeExtension", +"properties": { +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"extensionChains": { +"description": "Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.", +"items": { +"$ref": "ExtensionChain" +}, +"type": "array" +}, +"forwardingRules": { +"description": "Required. A list of references to the forwarding rules to which this service extension is attached. At least one forwarding rule is required. Only one `LbEdgeExtension` resource can be associated with a forwarding rule.", +"items": { +"type": "string" +}, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `LbEdgeExtension` resource. The format must comply with [the requirements for labels](https://cloud.google.com/compute/docs/labeling-resources#requirements) for Google Cloud resources.", +"type": "object" +}, +"loadBalancingScheme": { +"description": "Required. All forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `EXTERNAL_MANAGED`.", +"enum": [ +"LOAD_BALANCING_SCHEME_UNSPECIFIED", +"INTERNAL_MANAGED", +"EXTERNAL_MANAGED" +], +"enumDescriptions": [ +"Default value. Do not use.", +"Signifies that this is used for Internal HTTP(S) Load Balancing.", +"Signifies that this is used for External Managed HTTP(S) Load Balancing." +], +"type": "string" +}, +"name": { +"description": "Required. Identifier. Name of the `LbEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/lbEdgeExtensions/{lb_edge_extension}`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "LbRouteExtension": { "description": "`LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request.", "id": "LbRouteExtension", @@ -4744,6 +5019,31 @@ }, "type": "object" }, +"ListLbEdgeExtensionsResponse": { +"description": "Message for response to listing `LbEdgeExtension` resources.", +"id": "ListLbEdgeExtensionsResponse", +"properties": { +"lbEdgeExtensions": { +"description": "The list of `LbEdgeExtension` resources.", +"items": { +"$ref": "LbEdgeExtension" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results that the server returns.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListLbRouteExtensionsResponse": { "description": "Message for response to listing `LbRouteExtension` resources.", "id": "ListLbRouteExtensionsResponse", @@ -4876,6 +5176,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 9dcb9c71da..c10522883c 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2143,6 +2143,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -3095,7 +3100,7 @@ } } }, -"revision": "20250730", +"revision": "20251017", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuthzExtension": { @@ -3179,13 +3184,11 @@ "description": "Optional. The format of communication supported by the callout extension. If not specified, the default value `EXT_PROC_GRPC` is used.", "enum": [ "WIRE_FORMAT_UNSPECIFIED", -"EXT_PROC_GRPC", -"EXT_AUTHZ_GRPC" +"EXT_PROC_GRPC" ], "enumDescriptions": [ "Not specified.", -"The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream.", -"The extension service uses Envoy's `ext_authz` gRPC API. The backend service for the extension must use HTTP2, or H2C as the protocol. `EXT_AUTHZ_GRPC` is only supported for `AuthzExtension` resources." +"The extension service uses ext_proc gRPC API over a gRPC stream. This is the default value if the wire format is not specified. The backend service for the extension must use HTTP2 or H2C as the protocol. All `supported_events` for a client request are sent as part of the same gRPC stream." ], "type": "string" } @@ -3314,7 +3317,7 @@ "id": "ExtensionChainExtension", "properties": { "allowDynamicForwarding": { -"description": "Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error.", +"description": "Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error.", "type": "boolean" }, "authority": { @@ -3337,11 +3340,11 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", +"description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. For `AuthzExtension` resources, the metadata is available under the namespace `com.google.authz_extension.`. For other types of extensions, the metadata is available under the namespace `com.google....`. For example: `com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1`. The following variables are supported in the metadata: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name. This field must not be set for plugin extensions. Setting it results in a validation error. You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend. This field is subject to following limitations: * The total size of the metadata must be less than 1KiB. * The total number of keys in the metadata must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. * All values must be strings.", "type": "object" }, "name": { -"description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", +"description": "Optional. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. This field is required except for AuthzExtension.", "type": "string" }, "requestBodySendMode": { @@ -3359,7 +3362,7 @@ "type": "string" }, "responseBodySendMode": { -"description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", +"description": "Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`.", "enum": [ "BODY_SEND_MODE_UNSPECIFIED", "BODY_SEND_MODE_STREAMED", @@ -3377,7 +3380,7 @@ "type": "string" }, "supportedEvents": { -"description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event.", +"description": "Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported.", "items": { "enum": [ "EVENT_TYPE_UNSPECIFIED", @@ -5041,6 +5044,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 8754d7641da3164700071f079dfd2f76c6f3c687 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 51/70] feat(notebooks): update the api #### notebooks:v2 The following keys were added: - schemas.GceSetup.properties.instanceId (Total Keys: 2) --- docs/dyn/notebooks_v2.projects.locations.instances.html | 4 ++++ .../discovery_cache/documents/notebooks.v2.json | 7 ++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/dyn/notebooks_v2.projects.locations.instances.html b/docs/dyn/notebooks_v2.projects.locations.instances.html index 955ac6847c..ab4c9aad7d 100644 --- a/docs/dyn/notebooks_v2.projects.locations.instances.html +++ b/docs/dyn/notebooks_v2.projects.locations.instances.html @@ -257,6 +257,7 @@

Method Details

"customGpuDriverPath": "A String", # Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. "enableGpuDriver": True or False, # Optional. Whether the end user authorizes Google Cloud to install GPU driver on this VM instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. }, + "instanceId": "A String", # Output only. The unique ID of the Compute Engine instance resource. "machineType": "A String", # Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource "metadata": { # Optional. Custom metadata to apply to this instance. "a_key": "A String", @@ -539,6 +540,7 @@

Method Details

"customGpuDriverPath": "A String", # Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. "enableGpuDriver": True or False, # Optional. Whether the end user authorizes Google Cloud to install GPU driver on this VM instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. }, + "instanceId": "A String", # Output only. The unique ID of the Compute Engine instance resource. "machineType": "A String", # Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource "metadata": { # Optional. Custom metadata to apply to this instance. "a_key": "A String", @@ -754,6 +756,7 @@

Method Details

"customGpuDriverPath": "A String", # Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. "enableGpuDriver": True or False, # Optional. Whether the end user authorizes Google Cloud to install GPU driver on this VM instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. }, + "instanceId": "A String", # Output only. The unique ID of the Compute Engine instance resource. "machineType": "A String", # Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource "metadata": { # Optional. Custom metadata to apply to this instance. "a_key": "A String", @@ -907,6 +910,7 @@

Method Details

"customGpuDriverPath": "A String", # Optional. Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers. "enableGpuDriver": True or False, # Optional. Whether the end user authorizes Google Cloud to install GPU driver on this VM instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs. }, + "instanceId": "A String", # Output only. The unique ID of the Compute Engine instance resource. "machineType": "A String", # Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource "metadata": { # Optional. Custom metadata to apply to this instance. "a_key": "A String", diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index 9d1334f9b2..31662fd22e 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -971,7 +971,7 @@ } } }, -"revision": "20251008", +"revision": "20251016", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1464,6 +1464,11 @@ "$ref": "GPUDriverConfig", "description": "Optional. Configuration for GPU drivers." }, +"instanceId": { +"description": "Output only. The unique ID of the Compute Engine instance resource.", +"readOnly": true, +"type": "string" +}, "machineType": { "description": "Optional. The machine type of the VM instance. https://cloud.google.com/compute/docs/machine-resource", "type": "string" From 43e67c219bb4b250647cfe40c7e2162b77fb1227 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 52/70] fix(parametermanager): update the api #### parametermanager:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../parametermanager_v1.projects.locations.html | 2 +- .../documents/parametermanager.v1.json | 14 ++++++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/dyn/parametermanager_v1.projects.locations.html b/docs/dyn/parametermanager_v1.projects.locations.html index 91f009ad17..246e35cbc3 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.html +++ b/docs/dyn/parametermanager_v1.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index f075f12a55..97c5664993 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -230,6 +230,16 @@ "description": "Regional Endpoint", "endpointUrl": "https://parametermanager.southamerica-west1.rep.googleapis.com/", "location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://parametermanager.europe-west15.rep.googleapis.com/", +"location": "europe-west15" } ], "fullyEncodeReservedExpansion": true, @@ -361,7 +371,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -811,7 +821,7 @@ } } }, -"revision": "20250917", +"revision": "20251025", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { From ce151d0bd3d7b283a427ba6a46523edf49481bc0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 53/70] feat(paymentsresellersubscription): update the api #### paymentsresellersubscription:v1 The following keys were added: - schemas.CreateSubscriptionIntent.properties.cycleOptions.$ref (Total Keys: 1) - schemas.IntentPayload.properties.intentOptions.$ref (Total Keys: 1) - schemas.IntentPayloadIntentOptions (Total Keys: 3) --- ...subscription_v1.partners.userSessions.html | 9 ++++++++ .../paymentsresellersubscription.v1.json | 21 ++++++++++++++++++- 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html index d4a3286dc6..f9c7521bdb 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html @@ -98,6 +98,12 @@

Method Details

{ # Request to generate a user session. "intentPayload": { # The payload that describes the user intent. # The user intent to generate the user session. "createIntent": { # Intent message for creating a Subscription resource. # The request to create a subscription. + "cycleOptions": { # The cycle options when starting and resuming a subscription. # Optional. The cycle options for the subscription. + "initialCycleDuration": { # Describes the length of a period of a time. # Optional. The duration of the initial cycle. Only `DAY` is supported. If set, Google will start the subscription with this initial cycle duration starting at the request time (see available methods below). A prorated charge will be applied. This option is available to the following methods: - partners.subscriptions.provision - partners.subscriptions.resume - partners.userSessions.generate + "count": 42, # number of duration units to be included. + "unit": "A String", # The unit used for the duration + }, + }, "parent": "A String", # Required. The parent resource name, which is the identifier of the partner. "subscription": { # 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. # Required. The Subscription to be created. "cancellationDetails": { # Describes the details of a cancelled or cancelling subscription. # Output only. Describes the details of a cancelled subscription. Only applicable to subscription of state `STATE_CANCELLED`. @@ -238,6 +244,9 @@

Method Details

"entitleIntent": { # Intent for entitling the previously provisioned subscription to an end user. # The request to entitle a subscription. "name": "A String", # Required. The name of the subscription resource that is entitled to the current end user. It is in the format of "partners/{partner_id}/subscriptions/{subscriptionId}". }, + "intentOptions": { # The options for the intent. # Optional. The additional features for the intent. + "enableOfferOverride": True or False, # Optional. If true, Google may use a different product and promotion id from the ones in the `create_intent` based on the user's eligibility. Only applicable for certain YouTube free trial offers. + }, }, } diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index f486533795..f031e3640d 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -586,7 +586,7 @@ } } }, -"revision": "20251012", +"revision": "20251026", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -663,6 +663,10 @@ "description": "Intent message for creating a Subscription resource.", "id": "CreateSubscriptionIntent", "properties": { +"cycleOptions": { +"$ref": "CycleOptions", +"description": "Optional. The cycle options for the subscription." +}, "parent": { "description": "Required. The parent resource name, which is the identifier of the partner.", "type": "string" @@ -997,6 +1001,21 @@ "entitleIntent": { "$ref": "EntitleSubscriptionIntent", "description": "The request to entitle a subscription." +}, +"intentOptions": { +"$ref": "IntentPayloadIntentOptions", +"description": "Optional. The additional features for the intent." +} +}, +"type": "object" +}, +"IntentPayloadIntentOptions": { +"description": "The options for the intent.", +"id": "IntentPayloadIntentOptions", +"properties": { +"enableOfferOverride": { +"description": "Optional. If true, Google may use a different product and promotion id from the ones in the `create_intent` based on the user's eligibility. Only applicable for certain YouTube free trial offers.", +"type": "boolean" } }, "type": "object" From 2cfac408fb3e3a8e56ee62ca444a2e35db5f33eb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 54/70] feat(places): update the api #### places:v1 The following keys were added: - schemas.GoogleMapsPlacesV1Place.properties.movedPlace (Total Keys: 2) --- docs/dyn/places_v1.places.html | 22 ++++++++++++------- .../discovery_cache/documents/places.v1.json | 14 +++++++++--- 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/docs/dyn/places_v1.places.html b/docs/dyn/places_v1.places.html index 4a9b0c8c5a..2c639cb4f4 100644 --- a/docs/dyn/places_v1.places.html +++ b/docs/dyn/places_v1.places.html @@ -326,7 +326,7 @@

Method Details

], "businessStatus": "A String", # The business status for the place. "consumerAlert": { # The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. # The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. - "details": { # The details of the consumer alert message. # The details of the consumer alert message.ƒ + "details": { # The details of the consumer alert message. # The details of the consumer alert message. "aboutLink": { # The link to show together with the description to provide more information. # The link to show together with the description to provide more information. "title": "A String", # The title to show for the link. "uri": "A String", # The uri of the link. @@ -546,6 +546,8 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "menuForChildren": True or False, # Place has a children's menu. + "movedPlace": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in `places/{place_id}` format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved. + "movedPlaceId": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. "name": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. "nationalPhoneNumber": "A String", # A human-readable phone number for the place, in national format. "neighborhoodSummary": { # A summary of points of interest near the place. # A summary of points of interest near the place. @@ -771,7 +773,7 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, - "visitDate": { # 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 # The date when the author visited the place. This is trucated to the year and month of the visit. + "visitDate": { # 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 # The date when the author visited the place. This is truncated to the year and month of the visit. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -935,7 +937,7 @@

Method Details

], "businessStatus": "A String", # The business status for the place. "consumerAlert": { # The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. # The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. - "details": { # The details of the consumer alert message. # The details of the consumer alert message.ƒ + "details": { # The details of the consumer alert message. # The details of the consumer alert message. "aboutLink": { # The link to show together with the description to provide more information. # The link to show together with the description to provide more information. "title": "A String", # The title to show for the link. "uri": "A String", # The uri of the link. @@ -1155,6 +1157,8 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "menuForChildren": True or False, # Place has a children's menu. + "movedPlace": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in `places/{place_id}` format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved. + "movedPlaceId": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. "name": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. "nationalPhoneNumber": "A String", # A human-readable phone number for the place, in national format. "neighborhoodSummary": { # A summary of points of interest near the place. # A summary of points of interest near the place. @@ -1380,7 +1384,7 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, - "visitDate": { # 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 # The date when the author visited the place. This is trucated to the year and month of the visit. + "visitDate": { # 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 # The date when the author visited the place. This is truncated to the year and month of the visit. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -1571,7 +1575,7 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, - "visitDate": { # 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 # The date when the author visited the place. This is trucated to the year and month of the visit. + "visitDate": { # 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 # The date when the author visited the place. This is truncated to the year and month of the visit. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -1617,7 +1621,7 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, - "visitDate": { # 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 # The date when the author visited the place. This is trucated to the year and month of the visit. + "visitDate": { # 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 # The date when the author visited the place. This is truncated to the year and month of the visit. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. @@ -1684,7 +1688,7 @@

Method Details

], "businessStatus": "A String", # The business status for the place. "consumerAlert": { # The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. # The consumer alert message for the place when we detect suspicious review activity on a business or a business violates our policies. - "details": { # The details of the consumer alert message. # The details of the consumer alert message.ƒ + "details": { # The details of the consumer alert message. # The details of the consumer alert message. "aboutLink": { # The link to show together with the description to provide more information. # The link to show together with the description to provide more information. "title": "A String", # The title to show for the link. "uri": "A String", # The uri of the link. @@ -1904,6 +1908,8 @@

Method Details

"longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. }, "menuForChildren": True or False, # Place has a children's menu. + "movedPlace": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in `places/{place_id}` format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved. + "movedPlaceId": "A String", # If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved. "name": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. "nationalPhoneNumber": "A String", # A human-readable phone number for the place, in national format. "neighborhoodSummary": { # A summary of points of interest near the place. # A summary of points of interest near the place. @@ -2129,7 +2135,7 @@

Method Details

"languageCode": "A String", # The text's BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. "text": "A String", # Localized string in the language corresponding to language_code below. }, - "visitDate": { # 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 # The date when the author visited the place. This is trucated to the year and month of the visit. + "visitDate": { # 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 # The date when the author visited the place. This is truncated to the year and month of the visit. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index 7d95cfa274..2d323ac3ed 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -280,7 +280,7 @@ } } }, -"revision": "20251007", +"revision": "20251021", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1166,6 +1166,14 @@ "description": "Place has a children's menu.", "type": "boolean" }, +"movedPlace": { +"description": "If this Place is permanently closed and has moved to a new Place, this field contains the new Place's resource name, in `places/{place_id}` format. If this Place moved multiple times, this field will represent the first moved place. This field will not be populated if this Place has not moved.", +"type": "string" +}, +"movedPlaceId": { +"description": "If this Place is permanently closed and has moved to a new Place, this field contains the new Place's place ID. If this Place moved multiple times, this field will represent the first moved Place. This field will not be populated if this Place has not moved.", +"type": "string" +}, "name": { "description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", "type": "string" @@ -1433,7 +1441,7 @@ "properties": { "details": { "$ref": "GoogleMapsPlacesV1PlaceConsumerAlertDetails", -"description": "The details of the consumer alert message.\u0192" +"description": "The details of the consumer alert message." }, "languageCode": { "description": "The language code of the consumer alert message. This is a BCP 47 language code.", @@ -1910,7 +1918,7 @@ }, "visitDate": { "$ref": "GoogleTypeDate", -"description": "The date when the author visited the place. This is trucated to the year and month of the visit." +"description": "The date when the author visited the place. This is truncated to the year and month of the visit." } }, "type": "object" From 4c7a165e03a5c6297e31626fc32599c7eb97f4b6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 55/70] feat(pubsub): update the api #### pubsub:v1 The following keys were added: - schemas.CreateSnapshotRequest.properties.tags (Total Keys: 2) - schemas.Subscription.properties.tags (Total Keys: 2) - schemas.Topic.properties.tags (Total Keys: 2) --- docs/dyn/pubsub_v1.projects.snapshots.html | 3 +++ .../dyn/pubsub_v1.projects.subscriptions.html | 18 +++++++++++++++ docs/dyn/pubsub_v1.projects.topics.html | 18 +++++++++++++++ .../discovery_cache/documents/pubsub.v1.json | 23 ++++++++++++++++++- 4 files changed, 61 insertions(+), 1 deletion(-) diff --git a/docs/dyn/pubsub_v1.projects.snapshots.html b/docs/dyn/pubsub_v1.projects.snapshots.html index bd90ab1f10..15799e74a8 100644 --- a/docs/dyn/pubsub_v1.projects.snapshots.html +++ b/docs/dyn/pubsub_v1.projects.snapshots.html @@ -124,6 +124,9 @@

Method Details

"a_key": "A String", }, "subscription": "A String", # Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, } x__xgafv: string, V1 error format. diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index 69a4cdfbf0..8e061e6ef5 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -243,6 +243,9 @@

Method Details

"minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. } @@ -334,6 +337,9 @@

Method Details

"minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. } @@ -468,6 +474,9 @@

Method Details

"minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. } @@ -606,6 +615,9 @@

Method Details

"minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }, @@ -783,6 +795,9 @@

Method Details

"minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. }, @@ -876,6 +891,9 @@

Method Details

"minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, "state": "A String", # Output only. An output-only field indicating whether or not the subscription can receive messages. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "topic": "A String", # Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. "topicMessageRetentionDuration": "A String", # Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. } diff --git a/docs/dyn/pubsub_v1.projects.topics.html b/docs/dyn/pubsub_v1.projects.topics.html index 5baade1afa..d684d90a50 100644 --- a/docs/dyn/pubsub_v1.projects.topics.html +++ b/docs/dyn/pubsub_v1.projects.topics.html @@ -213,6 +213,9 @@

Method Details

"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted. }, "state": "A String", # Output only. An output-only field indicating the state of the topic. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, } x__xgafv: string, V1 error format. @@ -304,6 +307,9 @@

Method Details

"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted. }, "state": "A String", # Output only. An output-only field indicating the state of the topic. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, } @@ -420,6 +426,9 @@

Method Details

"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted. }, "state": "A String", # Output only. An output-only field indicating the state of the topic. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, } @@ -558,6 +567,9 @@

Method Details

"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted. }, "state": "A String", # Output only. An output-only field indicating the state of the topic. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, }, ], } @@ -668,6 +680,9 @@

Method Details

"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted. }, "state": "A String", # Output only. An output-only field indicating the state of the topic. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, }, "updateMask": "A String", # Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" but the `message_storage_policy` is not set in the `topic` provided above, then the updated value is determined by the policy configured at the project or organization level. } @@ -761,6 +776,9 @@

Method Details

"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted. }, "state": "A String", # Output only. An output-only field indicating the state of the topic. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, } diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index a2f953d7ba..6f7b19308c 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1648,7 +1648,7 @@ } } }, -"revision": "20250807", +"revision": "20251025", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -2122,6 +2122,13 @@ "subscription": { "description": "Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`.", "type": "string" +}, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" } }, "type": "object" @@ -2916,6 +2923,13 @@ "readOnly": true, "type": "string" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "topic": { "description": "Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted.", "type": "string" @@ -3035,6 +3049,13 @@ ], "readOnly": true, "type": "string" +}, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" } }, "type": "object" From 4e33eb5a3d67520a6056ca0f33e45227411f327e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:15 +0000 Subject: [PATCH 56/70] feat(redis): update the api #### redis:v1 The following keys were deleted: - schemas.ResourceMaintenanceSchedule.properties.phase.deprecated (Total Keys: 1) - schemas.ResourceMaintenanceSchedule.properties.week.type (Total Keys: 1) #### redis:v1beta1 The following keys were deleted: - schemas.ResourceMaintenanceSchedule.properties.phase.deprecated (Total Keys: 1) - schemas.ResourceMaintenanceSchedule.properties.week.type (Total Keys: 1) --- docs/dyn/redis_v1.projects.locations.html | 2 +- .../dyn/redis_v1beta1.projects.locations.html | 2 +- .../discovery_cache/documents/redis.v1.json | 57 ++++++++----------- .../documents/redis.v1beta1.json | 57 ++++++++----------- 4 files changed, 50 insertions(+), 68 deletions(-) diff --git a/docs/dyn/redis_v1.projects.locations.html b/docs/dyn/redis_v1.projects.locations.html index ff1bee4c7f..5c185ba667 100644 --- a/docs/dyn/redis_v1.projects.locations.html +++ b/docs/dyn/redis_v1.projects.locations.html @@ -145,7 +145,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/redis_v1beta1.projects.locations.html b/docs/dyn/redis_v1beta1.projects.locations.html index 02a8232e16..bfc4717d97 100644 --- a/docs/dyn/redis_v1beta1.projects.locations.html +++ b/docs/dyn/redis_v1beta1.projects.locations.html @@ -145,7 +145,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 7c95db23b0..e9a650ff0f 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1078,7 +1078,7 @@ } } }, -"revision": "20251009", +"revision": "20251021", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1950,7 +1950,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", -"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" +"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -1958,7 +1959,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not." +"Represents if a resources requires all incoming connections to use SSL or not.", +"Represents if a resource version is in extended support." ], "type": "string" } @@ -2327,7 +2329,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", -"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -2433,6 +2436,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2539,7 +2543,8 @@ false "Outdated version.", "Outdated client.", "Databoost is disabled.", -"Recommended maintenance policy." +"Recommended maintenance policy.", +"Resource version is in extended support." ], "type": "string" }, @@ -2979,7 +2984,8 @@ false "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", -"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -3085,6 +3091,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3191,7 +3198,8 @@ false "Outdated version.", "Outdated client.", "Databoost is disabled.", -"Recommended maintenance policy." +"Recommended maintenance policy.", +"Resource version is in extended support." ], "type": "string" } @@ -3244,7 +3252,8 @@ false "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", -"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" +"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -3252,7 +3261,8 @@ false "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not." +"Represents if a resources requires all incoming connections to use SSL or not.", +"Represents if a resource version is in extended support." ], "type": "string" } @@ -4985,29 +4995,6 @@ false "type": "string" }, "phase": { -"deprecated": true, -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead.", -"enum": [ -"WINDOW_PHASE_UNSPECIFIED", -"WINDOW_PHASE_ANY", -"WINDOW_PHASE_WEEK1", -"WINDOW_PHASE_WEEK2", -"WINDOW_PHASE_WEEK5" -], -"enumDescriptions": [ -"Phase is unspecified.", -"Any phase.", -"Week 1.", -"Week 2.", -"Week 5." -], -"type": "string" -}, -"time": { -"$ref": "TimeOfDay", -"description": "Optional. Preferred time to start the maintenance operation on the specified day." -}, -"week": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ "PHASE_UNSPECIFIED", @@ -5024,6 +5011,10 @@ false "Week 5." ], "type": "string" +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 705287e108..e71396fb51 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1078,7 +1078,7 @@ } } }, -"revision": "20251009", +"revision": "20251021", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1950,7 +1950,8 @@ "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", -"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" +"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -1958,7 +1959,8 @@ "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not." +"Represents if a resources requires all incoming connections to use SSL or not.", +"Represents if a resource version is in extended support." ], "type": "string" } @@ -2327,7 +2329,8 @@ "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", -"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -2433,6 +2436,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2539,7 +2543,8 @@ false "Outdated version.", "Outdated client.", "Databoost is disabled.", -"Recommended maintenance policy." +"Recommended maintenance policy.", +"Resource version is in extended support." ], "type": "string" }, @@ -2979,7 +2984,8 @@ false "SIGNAL_TYPE_OUTDATED_VERSION", "SIGNAL_TYPE_OUTDATED_CLIENT", "SIGNAL_TYPE_DATABOOST_DISABLED", -"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES" +"SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDeprecated": [ false, @@ -3085,6 +3091,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3191,7 +3198,8 @@ false "Outdated version.", "Outdated client.", "Databoost is disabled.", -"Recommended maintenance policy." +"Recommended maintenance policy.", +"Resource version is in extended support." ], "type": "string" } @@ -3244,7 +3252,8 @@ false "SIGNAL_TYPE_DATABASE_AUDITING_DISABLED", "SIGNAL_TYPE_NO_ROOT_PASSWORD", "SIGNAL_TYPE_EXPOSED_TO_PUBLIC_ACCESS", -"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS" +"SIGNAL_TYPE_UNENCRYPTED_CONNECTIONS", +"SIGNAL_TYPE_EXTENDED_SUPPORT" ], "enumDescriptions": [ "Unspecified signal type.", @@ -3252,7 +3261,8 @@ false "Represents database auditing is disabled.", "Represents if a database has a password configured for the root account or not.", "Represents if a resource is exposed to public access.", -"Represents if a resources requires all incoming connections to use SSL or not." +"Represents if a resources requires all incoming connections to use SSL or not.", +"Represents if a resource version is in extended support." ], "type": "string" } @@ -4992,29 +5002,6 @@ false "type": "string" }, "phase": { -"deprecated": true, -"description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance Deprecated. Use phase instead.", -"enum": [ -"WINDOW_PHASE_UNSPECIFIED", -"WINDOW_PHASE_ANY", -"WINDOW_PHASE_WEEK1", -"WINDOW_PHASE_WEEK2", -"WINDOW_PHASE_WEEK5" -], -"enumDescriptions": [ -"Phase is unspecified.", -"Any phase.", -"Week 1.", -"Week 2.", -"Week 5." -], -"type": "string" -}, -"time": { -"$ref": "TimeOfDay", -"description": "Optional. Preferred time to start the maintenance operation on the specified day." -}, -"week": { "description": "Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance", "enum": [ "PHASE_UNSPECIFIED", @@ -5031,6 +5018,10 @@ false "Week 5." ], "type": "string" +}, +"time": { +"$ref": "TimeOfDay", +"description": "Optional. Preferred time to start the maintenance operation on the specified day." } }, "type": "object" From 0fea359a42134488aa9678a98ada604ba268272b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 57/70] feat(retail): update the api #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaExportProductsRequest.properties.filter.deprecated (Total Keys: 1) #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaExportProductsRequest.properties.filter.deprecated (Total Keys: 1) --- ...2alpha.projects.locations.catalogs.branches.products.html | 2 +- ...v2beta.projects.locations.catalogs.branches.products.html | 2 +- .../discovery_cache/documents/retail.v2alpha.json | 5 +++-- googleapiclient/discovery_cache/documents/retail.v2beta.json | 5 +++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html index 7f898cbbbf..1f1e507319 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html @@ -639,7 +639,7 @@

Method Details

The object takes the form of: { # Request message for ExportProducts method. - "filter": "A String", # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-"tagA"`', which is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"` * Example 2: `lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant"` * Example 3: `tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"` * Example 4: `lastModifiedTime > "2012-04-23T18:25:43.511Z"` * Example 5: `availability = (IN_STOCK OR BACKORDER)` + "filter": "A String", # This field is deprecated. Any filter provided will be ignored. "outputConfig": { # The output configuration setting. # Required. The output location of the data. "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to. "datasetId": "A String", # Required. The ID of a BigQuery Dataset. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html index 1efa2f3b83..1fa3c33dcb 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html @@ -635,7 +635,7 @@

Method Details

The object takes the form of: { # Request message for ExportProducts method. - "filter": "A String", # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-"tagA"`', which is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"` * Example 2: `lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant"` * Example 3: `tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"` * Example 4: `lastModifiedTime > "2012-04-23T18:25:43.511Z"` * Example 5: `availability = (IN_STOCK OR BACKORDER)` + "filter": "A String", # This field is deprecated. Any filter provided will be ignored. "outputConfig": { # The output configuration setting. # Required. The output location of the data. "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to. "datasetId": "A String", # Required. The ID of a BigQuery Dataset. diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index ce7a4ee20c..c70386ca3a 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2874,7 +2874,7 @@ } } }, -"revision": "20251002", +"revision": "20251023", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5123,7 +5123,8 @@ "id": "GoogleCloudRetailV2alphaExportProductsRequest", "properties": { "filter": { -"description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", +"deprecated": true, +"description": "This field is deprecated. Any filter provided will be ignored.", "type": "string" }, "outputConfig": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 6c40e80c79..d3cad0508f 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2498,7 +2498,7 @@ } } }, -"revision": "20251002", +"revision": "20251023", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5395,7 +5395,8 @@ "id": "GoogleCloudRetailV2betaExportProductsRequest", "properties": { "filter": { -"description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", +"deprecated": true, +"description": "This field is deprecated. Any filter provided will be ignored.", "type": "string" }, "outputConfig": { From 86a7fc8b4b60f2675c6ffbaae60239a3f310b100 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 58/70] feat(securitycenter): update the api #### securitycenter:v1 The following keys were added: - resources.organizations.methods.updateOrganizationSettings.deprecated (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2IssueResourceApplication.properties.attributes.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes (Total Keys: 19) #### securitycenter:v1beta1 The following keys were added: - resources.organizations.methods.updateOrganizationSettings.deprecated (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2IssueResourceApplication.properties.attributes.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes (Total Keys: 19) #### securitycenter:v1beta2 The following keys were added: - schemas.GoogleCloudSecuritycenterV2IssueResourceApplication.properties.attributes.$ref (Total Keys: 1) - schemas.GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes (Total Keys: 19) --- .../documents/securitycenter.v1.json | 104 +++++++++++++++++- .../documents/securitycenter.v1beta1.json | 104 +++++++++++++++++- .../documents/securitycenter.v1beta2.json | 103 ++++++++++++++++- 3 files changed, 308 insertions(+), 3 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 14b4acec60..6fe7403610 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -1769,6 +1769,7 @@ ] }, "updateOrganizationSettings": { +"deprecated": true, "description": "Updates an organization's settings.", "flatPath": "v1/organizations/{organizationsId}/organizationSettings", "httpMethod": "PATCH", @@ -5943,7 +5944,7 @@ } } }, -"revision": "20251006", +"revision": "20251024", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -11843,6 +11844,10 @@ "description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { +"attributes": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", +"description": "Consumer provided attributes for the application" +}, "name": { "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" @@ -11850,6 +11855,103 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { +"description": "Consumer provided attributes for the application", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", +"properties": { +"businessOwners": { +"description": "Business team that ensures user needs are met and value is delivered", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +}, +"criticality": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", +"description": "User-defined criticality information." +}, +"developerOwners": { +"description": "Developer team that owns development and coding.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +}, +"environment": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", +"description": "User-defined environment information." +}, +"operatorOwners": { +"description": "Operator team that ensures runtime and operations.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { +"description": "Contact information of stakeholders.", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", +"properties": { +"email": { +"description": "Email address of the contacts.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { +"description": "Criticality of the Application, Service, or Workload", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", +"properties": { +"type": { +"description": "Criticality Type.", +"enum": [ +"CRITICALITY_TYPE_UNSPECIFIED", +"MISSION_CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"Unspecified type.", +"Mission critical service, application or workload.", +"High impact.", +"Medium impact.", +"Low impact." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { +"description": "Environment of the Application, Service, or Workload", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", +"properties": { +"type": { +"description": "Environment Type.", +"enum": [ +"ENVIRONMENT_TYPE_UNSPECIFIED", +"PRODUCTION", +"STAGING", +"TEST", +"DEVELOPMENT" +], +"enumDescriptions": [ +"Unspecified type.", +"Production environment.", +"Staging environment.", +"Test environment.", +"Development environment." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 6dbdc85abf..be0822c829 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -150,6 +150,7 @@ ] }, "updateOrganizationSettings": { +"deprecated": true, "description": "Updates an organization's settings.", "flatPath": "v1beta1/organizations/{organizationsId}/organizationSettings", "httpMethod": "PATCH", @@ -918,7 +919,7 @@ } } }, -"revision": "20251006", +"revision": "20251024", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6513,6 +6514,10 @@ "description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { +"attributes": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", +"description": "Consumer provided attributes for the application" +}, "name": { "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" @@ -6520,6 +6525,103 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { +"description": "Consumer provided attributes for the application", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", +"properties": { +"businessOwners": { +"description": "Business team that ensures user needs are met and value is delivered", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +}, +"criticality": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", +"description": "User-defined criticality information." +}, +"developerOwners": { +"description": "Developer team that owns development and coding.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +}, +"environment": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", +"description": "User-defined environment information." +}, +"operatorOwners": { +"description": "Operator team that ensures runtime and operations.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { +"description": "Contact information of stakeholders.", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", +"properties": { +"email": { +"description": "Email address of the contacts.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { +"description": "Criticality of the Application, Service, or Workload", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", +"properties": { +"type": { +"description": "Criticality Type.", +"enum": [ +"CRITICALITY_TYPE_UNSPECIFIED", +"MISSION_CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"Unspecified type.", +"Mission critical service, application or workload.", +"High impact.", +"Medium impact.", +"Low impact." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { +"description": "Environment of the Application, Service, or Workload", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", +"properties": { +"type": { +"description": "Environment Type.", +"enum": [ +"ENVIRONMENT_TYPE_UNSPECIFIED", +"PRODUCTION", +"STAGING", +"TEST", +"DEVELOPMENT" +], +"enumDescriptions": [ +"Unspecified type.", +"Production environment.", +"Staging environment.", +"Test environment.", +"Development environment." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index cda9826580..52959f2127 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -2003,7 +2003,7 @@ } } }, -"revision": "20251006", +"revision": "20251017", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -7501,6 +7501,10 @@ "description": "The AppHub application associated with the resource, if any.", "id": "GoogleCloudSecuritycenterV2IssueResourceApplication", "properties": { +"attributes": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", +"description": "Consumer provided attributes for the application" +}, "name": { "description": "The resource name of an Application. Format: `projects/{host-project-id}/locations/{location}/applications/{application-id}`", "type": "string" @@ -7508,6 +7512,103 @@ }, "type": "object" }, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes": { +"description": "Consumer provided attributes for the application", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributes", +"properties": { +"businessOwners": { +"description": "Business team that ensures user needs are met and value is delivered", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +}, +"criticality": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", +"description": "User-defined criticality information." +}, +"developerOwners": { +"description": "Developer team that owns development and coding.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +}, +"environment": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", +"description": "User-defined environment information." +}, +"operatorOwners": { +"description": "Operator team that ensures runtime and operations.", +"items": { +"$ref": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo": { +"description": "Contact information of stakeholders.", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesContactInfo", +"properties": { +"email": { +"description": "Email address of the contacts.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality": { +"description": "Criticality of the Application, Service, or Workload", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesCriticality", +"properties": { +"type": { +"description": "Criticality Type.", +"enum": [ +"CRITICALITY_TYPE_UNSPECIFIED", +"MISSION_CRITICAL", +"HIGH", +"MEDIUM", +"LOW" +], +"enumDescriptions": [ +"Unspecified type.", +"Mission critical service, application or workload.", +"High impact.", +"Medium impact.", +"Low impact." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment": { +"description": "Environment of the Application, Service, or Workload", +"id": "GoogleCloudSecuritycenterV2IssueResourceApplicationAttributesEnvironment", +"properties": { +"type": { +"description": "Environment Type.", +"enum": [ +"ENVIRONMENT_TYPE_UNSPECIFIED", +"PRODUCTION", +"STAGING", +"TEST", +"DEVELOPMENT" +], +"enumDescriptions": [ +"Unspecified type.", +"Production environment.", +"Staging environment.", +"Test environment.", +"Development environment." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata": { "description": "The AWS metadata of a resource associated with an issue.", "id": "GoogleCloudSecuritycenterV2IssueResourceAwsMetadata", From 12c39099f9ad700ef91ecf4fb7f36dfe05743066 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 59/70] feat(securityposture): update the api #### securityposture:v1 The following keys were added: - resources.organizations.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...ture_v1.organizations.locations.operations.html | 8 ++++++-- .../documents/securityposture.v1.json | 14 +++++++++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/dyn/securityposture_v1.organizations.locations.operations.html b/docs/dyn/securityposture_v1.organizations.locations.operations.html index b1bdc6e074..9317c69ca1 100644 --- a/docs/dyn/securityposture_v1.organizations.locations.operations.html +++ b/docs/dyn/securityposture_v1.organizations.locations.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/securityposture.v1.json b/googleapiclient/discovery_cache/documents/securityposture.v1.json index ee64c2fab5..f1d451cf08 100644 --- a/googleapiclient/discovery_cache/documents/securityposture.v1.json +++ b/googleapiclient/discovery_cache/documents/securityposture.v1.json @@ -220,6 +220,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -898,7 +903,7 @@ } } }, -"revision": "20250819", +"revision": "20251028", "rootUrl": "https://securityposture.googleapis.com/", "schemas": { "AssetDetails": { @@ -1265,6 +1270,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 36c302d4731c597d28dd2c9d0b03b53331f18a17 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 60/70] feat(serviceconsumermanagement): update the api #### serviceconsumermanagement:v1 The following keys were added: - resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) - schemas.V1Beta1ServiceIdentity.properties.projectRole.type (Total Keys: 1) #### serviceconsumermanagement:v1beta1 The following keys were added: - schemas.V1Beta1ServiceIdentity.properties.projectRole.type (Total Keys: 1) --- ...erviceconsumermanagement_v1.operations.html | 8 ++++++-- .../serviceconsumermanagement.v1.json | 18 +++++++++++++++++- .../serviceconsumermanagement.v1beta1.json | 6 +++++- 3 files changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/dyn/serviceconsumermanagement_v1.operations.html b/docs/dyn/serviceconsumermanagement_v1.operations.html index 9000c7b2a2..eace45234e 100644 --- a/docs/dyn/serviceconsumermanagement_v1.operations.html +++ b/docs/dyn/serviceconsumermanagement_v1.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 9b5bfd1fae..9f4eba0c7a 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -216,6 +216,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -542,7 +547,7 @@ } } }, -"revision": "20250919", +"revision": "20251023", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1789,6 +1794,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3328,6 +3340,10 @@ "description": "P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default`", "type": "string" }, +"projectRole": { +"description": "The project-level IAM role defined in the service agent's grant configuration. This is the standard role intended for this service agent. This field is populated regardless of the `skip_role_attach` option in the request. If `skip_role_attach` is true, the caller can use this value to know which role they are responsible for granting.", +"type": "string" +}, "tag": { "description": "The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to \"default\".", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 41825cfbf5..919e82ded1 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -724,7 +724,7 @@ } } }, -"revision": "20250919", +"revision": "20251023", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -3452,6 +3452,10 @@ "description": "P4 service identity resource name. An example name would be: `services/serviceconsumermanagement.googleapis.com/projects/123/serviceIdentities/default`", "type": "string" }, +"projectRole": { +"description": "The project-level IAM role defined in the service agent's grant configuration. This is the standard role intended for this service agent. This field is populated regardless of the `skip_role_attach` option in the request. If `skip_role_attach` is true, the caller can use this value to know which role they are responsible for granting.", +"type": "string" +}, "tag": { "description": "The P4 service identity configuration tag. This must be defined in activation_grants. If not specified when creating the account, the tag is set to \"default\".", "type": "string" From 52452f10aa2f6ac0af8810fe71e347f570896ecb Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 61/70] feat(serviceusage): update the api #### serviceusage:v1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaConsumerPolicy.properties.annotations (Total Keys: 2) - schemas.McpPolicy.properties.contentSecurity.$ref (Total Keys: 1) The following keys were added: - resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ContentSecurityPolicy (Total Keys: 5) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) - schemas.UpdateContentSecurityPolicyMetadata (Total Keys: 2) #### serviceusage:v1beta1 The following keys were deleted: - schemas.GoogleApiServiceusageV2betaConsumerPolicy.properties.annotations (Total Keys: 2) - schemas.McpPolicy.properties.contentSecurity.$ref (Total Keys: 1) The following keys were added: - resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ContentSecurityPolicy (Total Keys: 5) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) - schemas.UpdateContentSecurityPolicyMetadata (Total Keys: 2) --- docs/dyn/serviceusage_v1.operations.html | 8 +++- docs/dyn/serviceusage_v1beta1.operations.html | 8 +++- .../documents/serviceusage.v1.json | 47 ++++++++++++++----- .../documents/serviceusage.v1beta1.json | 47 ++++++++++++++----- 4 files changed, 82 insertions(+), 28 deletions(-) diff --git a/docs/dyn/serviceusage_v1.operations.html b/docs/dyn/serviceusage_v1.operations.html index cc88e3ede7..70461ea302 100644 --- a/docs/dyn/serviceusage_v1.operations.html +++ b/docs/dyn/serviceusage_v1.operations.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -176,7 +176,7 @@

Method Details

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None) + list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -184,6 +184,7 @@ 
Method Details

   name: string, The name of the operation's parent resource.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -215,6 +216,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/serviceusage_v1beta1.operations.html b/docs/dyn/serviceusage_v1beta1.operations.html index a5c4247269..4d439ae178 100644 --- a/docs/dyn/serviceusage_v1beta1.operations.html +++ b/docs/dyn/serviceusage_v1beta1.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(filter=None, name=None, pageSize=None, pageToken=None, x__xgafv=None) + list(filter=None, name=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   name: string, The name of the operation's parent resource.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 608e0c5840..599edf2f25 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -221,6 +221,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/operations", @@ -426,7 +431,7 @@ } } }, -"revision": "20250919", +"revision": "20251021", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1185,6 +1190,22 @@ }, "type": "object" }, +"ContentSecurityPolicy": { +"description": "Content Security Policy contains the content security related policy of a resource.", +"id": "ContentSecurityPolicy", +"properties": { +"mcpContentSecurity": { +"$ref": "ContentSecurity", +"description": "mcp_content_security contains the content security related settings at resource level for MCP traffic." +}, +"name": { +"description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/contentSecurityPolicies/default`, `projects/{PROJECT_ID}/contentSecurityPolicies/default`, We only support project level content security policy for now.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ContentSecurityProvider": { "description": "ContentSecurityProvider contains the name of content security provider.", "id": "ContentSecurityProvider", @@ -2301,13 +2322,6 @@ "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "GoogleApiServiceusageV2betaConsumerPolicy", "properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", -"type": "object" -}, "createTime": { "description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", "format": "google-datetime", @@ -2636,6 +2650,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -2768,10 +2789,6 @@ "description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", "id": "McpPolicy", "properties": { -"contentSecurity": { -"$ref": "ContentSecurity", -"description": "ContentSecurity contains the content security related fields of a MCP policy." -}, "createTime": { "description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", "format": "google-datetime", @@ -3781,6 +3798,12 @@ "properties": {}, "type": "object" }, +"UpdateContentSecurityPolicyMetadata": { +"description": "Metadata for the `UpdateContentSecurityPolicy` method.", +"id": "UpdateContentSecurityPolicyMetadata", +"properties": {}, +"type": "object" +}, "UpdateMcpPolicyMetadata": { "description": "Metadata for the `UpdateMcpPolicy` method.", "id": "UpdateMcpPolicyMetadata", diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 3f5fd5f70a..ed9b05fcff 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -166,6 +166,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/operations", @@ -964,7 +969,7 @@ } } }, -"revision": "20250919", +"revision": "20251021", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1781,6 +1786,22 @@ }, "type": "object" }, +"ContentSecurityPolicy": { +"description": "Content Security Policy contains the content security related policy of a resource.", +"id": "ContentSecurityPolicy", +"properties": { +"mcpContentSecurity": { +"$ref": "ContentSecurity", +"description": "mcp_content_security contains the content security related settings at resource level for MCP traffic." +}, +"name": { +"description": "Output only. The resource name of the policy. Only the `default` policy is supported. We allow the following formats: `projects/{PROJECT_NUMBER}/contentSecurityPolicies/default`, `projects/{PROJECT_ID}/contentSecurityPolicies/default`, We only support project level content security policy for now.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ContentSecurityProvider": { "description": "ContentSecurityProvider contains the name of content security provider.", "id": "ContentSecurityProvider", @@ -2878,13 +2899,6 @@ "description": "Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy.", "id": "GoogleApiServiceusageV2betaConsumerPolicy", "properties": { -"annotations": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. [AIP-128](https://google.aip.dev/128#annotations)", -"type": "object" -}, "createTime": { "description": "Output only. The time the policy was created. For singleton policies, this is the first touch of the policy.", "format": "google-datetime", @@ -3331,6 +3345,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" @@ -3463,10 +3484,6 @@ "description": "MCP Consumer Policy is a set of rules that define MCP related policy for a cloud resource hierarchy.", "id": "McpPolicy", "properties": { -"contentSecurity": { -"$ref": "ContentSecurity", -"description": "ContentSecurity contains the content security related fields of a MCP policy." -}, "createTime": { "description": "Output only. The time the policy was created. For singleton policies (such as the `default` policy), this is the first touch of the policy.", "format": "google-datetime", @@ -4669,6 +4686,12 @@ "properties": {}, "type": "object" }, +"UpdateContentSecurityPolicyMetadata": { +"description": "Metadata for the `UpdateContentSecurityPolicy` method.", +"id": "UpdateContentSecurityPolicyMetadata", +"properties": {}, +"type": "object" +}, "UpdateMcpPolicyMetadata": { "description": "Metadata for the `UpdateMcpPolicy` method.", "id": "UpdateMcpPolicyMetadata", From 0e4b4da7a81051ae9c6170ecf63ed0d49af6e58e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 62/70] feat(solar): update the api #### solar:v1 The following keys were added: - resources.buildingInsights.methods.findClosest.parameters.exactQualityRequired (Total Keys: 2) --- docs/dyn/solar_v1.buildingInsights.html | 5 +++-- googleapiclient/discovery_cache/documents/solar.v1.json | 7 ++++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/dyn/solar_v1.buildingInsights.html b/docs/dyn/solar_v1.buildingInsights.html index 92f09bc2b4..aef86578ec 100644 --- a/docs/dyn/solar_v1.buildingInsights.html +++ b/docs/dyn/solar_v1.buildingInsights.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- findClosest(experiments=None, location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None)

+ findClosest(exactQualityRequired=None, experiments=None, location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None)

Locates the building whose centroid is closest to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.

Method Details

@@ -87,10 +87,11 @@

Method Details

- findClosest(experiments=None, location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None) + findClosest(exactQualityRequired=None, experiments=None, location_latitude=None, location_longitude=None, requiredQuality=None, x__xgafv=None) 
Locates the building whose centroid is closest to a query point. Returns an error with code `NOT_FOUND` if there are no buildings within approximately 50m of the query point.
 
 Args:
+  exactQualityRequired: boolean, Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`.
   experiments: string, Optional. Specifies the pre-GA features to enable. (repeated)
     Allowed values
       EXPERIMENT_UNSPECIFIED - No experiments are specified.
diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json
index b15fdfd13e..e96f7d10cc 100644
--- a/googleapiclient/discovery_cache/documents/solar.v1.json
+++ b/googleapiclient/discovery_cache/documents/solar.v1.json
@@ -114,6 +114,11 @@
 "id": "solar.buildingInsights.findClosest",
 "parameterOrder": [],
 "parameters": {
+"exactQualityRequired": {
+"description": "Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`.",
+"location": "query",
+"type": "boolean"
+},
 "experiments": {
 "description": "Optional. Specifies the pre-GA features to enable.",
 "enum": [
@@ -299,7 +304,7 @@
 }
 }
 },
-"revision": "20250804",
+"revision": "20251027",
 "rootUrl": "https://solar.googleapis.com/",
 "schemas": {
 "BuildingInsights": {

From b9db052bbd366e3af8f7912402e7a6c3c8e2339f Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:16 +0000
Subject: [PATCH 63/70] feat(sqladmin): update the api

#### sqladmin:v1

The following keys were added:
- schemas.Settings.properties.dataApiAccess.type (Total Keys: 1)

#### sqladmin:v1beta4

The following keys were added:
- schemas.Settings.properties.dataApiAccess.type (Total Keys: 1)
---
 docs/dyn/sqladmin_v1.Backups.html             |  4 +++
 docs/dyn/sqladmin_v1.instances.html           | 14 +++++++---
 docs/dyn/sqladmin_v1beta4.backups.html        |  4 +++
 docs/dyn/sqladmin_v1beta4.instances.html      |  6 ++++
 .../documents/sqladmin.v1.json                | 24 ++++++++++++----
 .../documents/sqladmin.v1beta4.json           | 28 ++++++++++++++-----
 6 files changed, 64 insertions(+), 16 deletions(-)

diff --git a/docs/dyn/sqladmin_v1.Backups.html b/docs/dyn/sqladmin_v1.Backups.html
index d9da5442f1..b5951fdb1d 100644
--- a/docs/dyn/sqladmin_v1.Backups.html
+++ b/docs/dyn/sqladmin_v1.Backups.html
@@ -327,6 +327,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
@@ -1044,6 +1045,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
@@ -1447,6 +1449,7 @@ 
Method Details

           },
           "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
           "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+          "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
           "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
             "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
           },
@@ -1864,6 +1867,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html
index d3a9ffad90..384fc93f09 100644
--- a/docs/dyn/sqladmin_v1.instances.html
+++ b/docs/dyn/sqladmin_v1.instances.html
@@ -763,13 +763,13 @@ 
Method Details

   
Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
 
 Args:
-  project: string, Project ID of the source as well as the clone Cloud SQL instance. (required)
-  instance: string, The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. (required)
+  project: string, Required. Project ID of the source as well as the clone Cloud SQL instance. (required)
+  instance: string, Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Database instance clone request.
-  "cloneContext": { # Database instance clone context. # Contains details about the clone operation.
+  "cloneContext": { # Database instance clone context. # Required. Contains details about the clone operation.
     "allocatedIpRange": "A String", # The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the cloned instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use.
     "binLogCoordinates": { # Binary log coordinates. # Binary log coordinates, if specified, identify the position up to which the source instance is cloned. If not specified, the source instance is cloned up to the most recent binary log coordinates.
       "binLogFileName": "A String", # Name of the binary log file for a Cloud SQL instance.
@@ -779,7 +779,7 @@ 
Method Details

     "databaseNames": [ # (SQL Server only) Clone only the specified databases from the source instance. Clone all databases if empty.
       "A String",
     ],
-    "destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone.
+    "destinationInstanceName": "A String", # Required. Name of the Cloud SQL instance to be created as a clone.
     "kind": "A String", # This is always `sql#cloneContext`.
     "pitrTimestampMs": "A String", # Reserved for future use.
     "pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned.
@@ -2170,6 +2170,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
@@ -2747,6 +2748,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
@@ -3275,6 +3277,7 @@ 
Method Details

         },
         "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
         "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+        "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
         "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
           "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
         },
@@ -3697,6 +3700,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
@@ -5279,6 +5283,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
@@ -6640,6 +6645,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html
index ff36677019..908b8b140b 100644
--- a/docs/dyn/sqladmin_v1beta4.backups.html
+++ b/docs/dyn/sqladmin_v1beta4.backups.html
@@ -332,6 +332,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
@@ -1049,6 +1050,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
@@ -1452,6 +1454,7 @@ 
Method Details

           },
           "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
           "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+          "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
           "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
             "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
           },
@@ -1869,6 +1872,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index da6da7b178..fef4560f82 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -2170,6 +2170,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
@@ -2747,6 +2748,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
@@ -3275,6 +3277,7 @@ 
Method Details

         },
         "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
         "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+        "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
         "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
           "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
         },
@@ -3697,6 +3700,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
@@ -5279,6 +5283,7 @@ 
Method Details

       },
       "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
       "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+      "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
       "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
         "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
       },
@@ -6640,6 +6645,7 @@ 
Method Details

     },
     "connectorEnforcement": "A String", # Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors) Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
     "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+    "dataApiAccess": "A String", # This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.
     "dataCacheConfig": { # Data cache configurations. # Configuration for data cache.
       "dataCacheEnabled": True or False, # Whether data cache is enabled for the instance.
     },
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
index 0140abbb0d..9d986d4a55 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
@@ -962,13 +962,13 @@
 ],
 "parameters": {
 "instance": {
-"description": "The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.",
+"description": "Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "project": {
-"description": "Project ID of the source as well as the clone Cloud SQL instance.",
+"description": "Required. Project ID of the source as well as the clone Cloud SQL instance.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2685,7 +2685,7 @@
 }
 }
 },
-"revision": "20251006",
+"revision": "20251019",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -3626,7 +3626,7 @@ false
 "type": "array"
 },
 "destinationInstanceName": {
-"description": "Name of the Cloud SQL instance to be created as a clone.",
+"description": "Required. Name of the Cloud SQL instance to be created as a clone.",
 "type": "string"
 },
 "kind": {
@@ -5681,7 +5681,7 @@ false
 "properties": {
 "cloneContext": {
 "$ref": "CloneContext",
-"description": "Contains details about the clone operation."
+"description": "Required. Contains details about the clone operation."
 }
 },
 "type": "object"
@@ -7421,6 +7421,20 @@ true
 "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.",
 "type": "boolean"
 },
+"dataApiAccess": {
+"description": "This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.",
+"enum": [
+"DATA_API_ACCESS_UNSPECIFIED",
+"DISALLOW_DATA_API",
+"ALLOW_DATA_API"
+],
+"enumDescriptions": [
+"Unspecified, effectively the same as `DISALLOW_DATA_API`.",
+"Disallow using Data API to connect to the instance.",
+"Allow using Data API to connect to the instance. For private IP instances, this will allow authorized users to access the instance from the public internet."
+],
+"type": "string"
+},
 "dataCacheConfig": {
 "$ref": "DataCacheConfig",
 "description": "Configuration for data cache."
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
index faba002cfc..74f723f966 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
@@ -2685,7 +2685,7 @@
 }
 }
 },
-"revision": "20251006",
+"revision": "20251023",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2977,7 +2977,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
-"The database version is AGBALA. The database version is PostgreSQL 18.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -3439,7 +3439,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
-"The database version is AGBALA. The database version is PostgreSQL 18.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -3888,7 +3888,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
-"The database version is AGBALA. The database version is PostgreSQL 18.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -4293,7 +4293,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
-"The database version is AGBALA. The database version is PostgreSQL 18.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -5247,7 +5247,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
-"The database version is AGBALA. The database version is PostgreSQL 18.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -7001,7 +7001,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
-"The database version is AGBALA. The database version is PostgreSQL 18.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -7422,6 +7422,20 @@ true
 "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.",
 "type": "boolean"
 },
+"dataApiAccess": {
+"description": "This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default.",
+"enum": [
+"DATA_API_ACCESS_UNSPECIFIED",
+"DISALLOW_DATA_API",
+"ALLOW_DATA_API"
+],
+"enumDescriptions": [
+"Unspecified, effectively the same as `DISALLOW_DATA_API`.",
+"Disallow using Data API to connect to the instance.",
+"Allow using Data API to connect to the instance. For private IP instances, this will allow authorized users to access the instance from the public internet."
+],
+"type": "string"
+},
 "dataCacheConfig": {
 "$ref": "DataCacheConfig",
 "description": "Configuration for data cache."

From 27a2e897c447c64d6605bd3daab085e172844f9a Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 4 Nov 2025 07:10:16 +0000
Subject: [PATCH 64/70] feat(storagetransfer): update the api

#### storagetransfer:v1

The following keys were added:
- resources.transferOperations.methods.list.parameters.returnPartialSuccess (Total Keys: 2)
- schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2)
---
 .../storagetransfer_v1.transferOperations.html   |  8 ++++++--
 .../documents/storagetransfer.v1.json            | 16 ++++++++++++++--
 2 files changed, 20 insertions(+), 4 deletions(-)

diff --git a/docs/dyn/storagetransfer_v1.transferOperations.html b/docs/dyn/storagetransfer_v1.transferOperations.html
index ccbc7d0685..2b7e02537e 100644
--- a/docs/dyn/storagetransfer_v1.transferOperations.html
+++ b/docs/dyn/storagetransfer_v1.transferOperations.html
@@ -84,7 +84,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
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.

 

-  list(name, filter, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, filter, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

 
Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.

 

   list_next()

@@ -161,7 +161,7 @@ 
Method Details
- list(name, filter, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.
 
 Args:
@@ -169,6 +169,7 @@ 
Method Details

   filter: string, Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern", "operationNames":["opid1","opid2",...], "operationNamePattern": "operation_name_pattern", "minCreationTime": "min_creation_time", "maxCreationTime": "max_creation_time", "transferStatuses":["status1","status2",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is the only argument that is required. If specified, `jobNamePattern` and `operationNamePattern` must match the full job or operation name respectively. '*' is a wildcard matching 0 or more characters. `minCreationTime` and `maxCreationTime` should be timestamps encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED. (required)
   pageSize: integer, The list page size. The max allowed value is 256.
   pageToken: string, The list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -200,6 +201,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json index f422ba7c25..e7f0c2d7bd 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -563,6 +563,11 @@ "description": "The list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}", @@ -632,7 +637,7 @@ } } }, -"revision": "20250801", +"revision": "20251010", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -837,7 +842,7 @@ "type": "object" }, "ErrorLogEntry": { -"description": "An entry describing an error that has occurred.", +"description": "LINT.IfChange An entry describing an error that has occurred.", "id": "ErrorLogEntry", "properties": { "errorDetails": { @@ -1040,6 +1045,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From 822296edbf7a931590871b09fb7ffb77c9f24a6e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 65/70] feat(trafficdirector): update the api #### trafficdirector:v2 The following keys were added: - endpoints (Total Keys: 1) #### trafficdirector:v3 The following keys were added: - endpoints (Total Keys: 1) --- .../documents/trafficdirector.v2.json | 229 +++++++++++++++++- .../documents/trafficdirector.v3.json | 229 +++++++++++++++++- 2 files changed, 456 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json index d7ee93a5c9..819f213b87 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v2.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v2.json @@ -15,6 +15,233 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/traffic-director", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -128,7 +355,7 @@ } } }, -"revision": "20250908", +"revision": "20251015", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json index 4da1f10af9..1129cfc733 100644 --- a/googleapiclient/discovery_cache/documents/trafficdirector.v3.json +++ b/googleapiclient/discovery_cache/documents/trafficdirector.v3.json @@ -15,6 +15,233 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/traffic-director", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://trafficdirector.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -128,7 +355,7 @@ } } }, -"revision": "20250908", +"revision": "20251015", "rootUrl": "https://trafficdirector.googleapis.com/", "schemas": { "Address": { From e3cf5e1ac365bdd556c3a4e36af321dab3147595 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 66/70] feat(vmmigration): update the api #### vmmigration:v1 The following keys were added: - schemas.ComputeEngineTargetDefaults.properties.storagePool.type (Total Keys: 1) - schemas.ComputeEngineTargetDetails.properties.storagePool.type (Total Keys: 1) --- docs/dyn/vmmigration_v1.projects.locations.html | 2 +- ...gration_v1.projects.locations.imageImports.html | 12 ++++++------ ...cts.locations.imageImports.imageImportJobs.html | 4 ++-- ...s.locations.sources.migratingVms.cloneJobs.html | 3 +++ ...locations.sources.migratingVms.cutoverJobs.html | 3 +++ ...v1.projects.locations.sources.migratingVms.html | 12 ++++++++++++ .../vmmigration_v1alpha1.projects.locations.html | 2 +- .../discovery_cache/documents/vmmigration.v1.json | 14 +++++++++++--- .../documents/vmmigration.v1alpha1.json | 4 ++-- 9 files changed, 41 insertions(+), 15 deletions(-) diff --git a/docs/dyn/vmmigration_v1.projects.locations.html b/docs/dyn/vmmigration_v1.projects.locations.html index dd9c3a04f3..ca958f0b95 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.html +++ b/docs/dyn/vmmigration_v1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html index 5a79bb7af9..0a65647625 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html @@ -119,7 +119,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. @@ -213,7 +213,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. @@ -432,7 +432,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. @@ -526,7 +526,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. @@ -685,7 +685,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. @@ -779,7 +779,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html index c67ddc6fc6..e098c65a88 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html @@ -160,7 +160,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. @@ -320,7 +320,7 @@

Method Details

"additionalLicenses": [ # Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME "A String", ], - "dataDiskImageImport": { # Mentions that the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + "dataDiskImageImport": { # Used when the image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. }, "description": "A String", # Optional. An optional description of the image. "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the image. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html index 8cb5a3fc36..2ad9e0b6ba 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -226,6 +226,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -380,6 +381,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -510,6 +512,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html index 41e2447495..ba1db178b6 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -226,6 +226,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -490,6 +491,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -730,6 +732,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 573d6406fd..cc621189b4 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -321,6 +321,7 @@

Method Details

], "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # Optional. The service account to associate the VM with. + "storagePool": "A String", # Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. @@ -544,6 +545,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -654,6 +656,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -1167,6 +1170,7 @@

Method Details

], "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # Optional. The service account to associate the VM with. + "storagePool": "A String", # Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. @@ -1390,6 +1394,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -1500,6 +1505,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -1872,6 +1878,7 @@

Method Details

], "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # Optional. The service account to associate the VM with. + "storagePool": "A String", # Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. @@ -2095,6 +2102,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -2205,6 +2213,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -2581,6 +2590,7 @@

Method Details

], "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # Optional. The service account to associate the VM with. + "storagePool": "A String", # Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "targetProject": "A String", # The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. @@ -2804,6 +2814,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, @@ -2914,6 +2925,7 @@

Method Details

"project": "A String", # The Google Cloud target project ID or project name. "secureBoot": True or False, # Defines whether the instance has Secure Boot enabled. This can be set to true only if the VM boot option is EFI. "serviceAccount": "A String", # The service account to associate the VM with. + "storagePool": "A String", # Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: "projects/my-project/zones/us-central1-a/storagePools/my-storage-pool". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type. "vmName": "A String", # The name of the VM to create. "zone": "A String", # The zone in which to create the VM. }, diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.html index dfe2d45dc1..be9c8fcde5 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index d4c657c97b..74e45c0622 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2548,7 +2548,7 @@ } } }, -"revision": "20251002", +"revision": "20251030", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -3736,6 +3736,10 @@ "description": "Optional. The service account to associate the VM with.", "type": "string" }, +"storagePool": { +"description": "Optional. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", +"type": "string" +}, "targetProject": { "description": "The full path of the resource of type TargetProject which represents the Compute Engine project in which to create this VM.", "type": "string" @@ -3908,6 +3912,10 @@ "description": "The service account to associate the VM with.", "type": "string" }, +"storagePool": { +"description": "Optional. The storage pool used for the VM disks. If specified this will be the storage pool in which the disk is created. This is the full path of the storage pool resource, for example: \"projects/my-project/zones/us-central1-a/storagePools/my-storage-pool\". The storage pool must be in the same project and zone as the target disks. The storage pool's type must match the disk type.", +"type": "string" +}, "vmName": { "description": "The name of the VM to create.", "type": "string" @@ -4153,7 +4161,7 @@ "type": "object" }, "DataDiskImageImport": { -"description": "Mentions that the image import is not using OS adaptation process.", +"description": "Used when the image import is not using OS adaptation process.", "id": "DataDiskImageImport", "properties": {}, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 9c5e693b2e..c17c5ae53f 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2548,7 +2548,7 @@ } } }, -"revision": "20251002", +"revision": "20251023", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { From d92cdbdb9e6a4926b7ace1668b1aa6bc54cd2774 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:16 +0000 Subject: [PATCH 67/70] feat(vmwareengine): update the api #### vmwareengine:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...areengine_v1.projects.locations.operations.html | 8 ++++++-- .../discovery_cache/documents/vmwareengine.v1.json | 14 +++++++++++++- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/dyn/vmwareengine_v1.projects.locations.operations.html b/docs/dyn/vmwareengine_v1.projects.locations.operations.html index ec33b35c61..f19d0333f2 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.operations.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -157,6 +157,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -188,6 +189,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index f6a2b094ad..3170fc57c6 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -1127,6 +1127,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -3396,7 +3401,7 @@ } } }, -"revision": "20250912", +"revision": "20251020", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AcceleratePrivateCloudDeletionRequest": { @@ -4451,6 +4456,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From b8f17a0f2154606210c2b43aac37c545f32c0ef3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:17 +0000 Subject: [PATCH 68/70] feat(vpcaccess): update the api #### vpcaccess:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) #### vpcaccess:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- docs/dyn/vpcaccess_v1.projects.locations.html | 2 +- ...caccess_v1.projects.locations.operations.html | 8 ++++++-- .../vpcaccess_v1beta1.projects.locations.html | 2 +- ...ss_v1beta1.projects.locations.operations.html | 8 ++++++-- .../discovery_cache/documents/vpcaccess.v1.json | 16 ++++++++++++++-- .../documents/vpcaccess.v1beta1.json | 16 ++++++++++++++-- 6 files changed, 42 insertions(+), 10 deletions(-) diff --git a/docs/dyn/vpcaccess_v1.projects.locations.html b/docs/dyn/vpcaccess_v1.projects.locations.html index 1c68e12981..c00e926ecf 100644 --- a/docs/dyn/vpcaccess_v1.projects.locations.html +++ b/docs/dyn/vpcaccess_v1.projects.locations.html @@ -105,7 +105,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/vpcaccess_v1.projects.locations.operations.html b/docs/dyn/vpcaccess_v1.projects.locations.operations.html index 328733dff0..b9636cfce6 100644 --- a/docs/dyn/vpcaccess_v1.projects.locations.operations.html +++ b/docs/dyn/vpcaccess_v1.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/vpcaccess_v1beta1.projects.locations.html b/docs/dyn/vpcaccess_v1beta1.projects.locations.html index 2b9112cf9e..eddd0bbb6b 100644 --- a/docs/dyn/vpcaccess_v1beta1.projects.locations.html +++ b/docs/dyn/vpcaccess_v1beta1.projects.locations.html @@ -105,7 +105,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/vpcaccess_v1beta1.projects.locations.operations.html b/docs/dyn/vpcaccess_v1beta1.projects.locations.operations.html index 53b849df6c..c5a20aa14c 100644 --- a/docs/dyn/vpcaccess_v1beta1.projects.locations.operations.html +++ b/docs/dyn/vpcaccess_v1beta1.projects.locations.operations.html @@ -81,7 +81,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -128,7 +128,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -136,6 +136,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -167,6 +168,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/vpcaccess.v1.json b/googleapiclient/discovery_cache/documents/vpcaccess.v1.json index f3cafb208c..7fdf4b5edb 100644 --- a/googleapiclient/discovery_cache/documents/vpcaccess.v1.json +++ b/googleapiclient/discovery_cache/documents/vpcaccess.v1.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -373,6 +373,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -390,7 +395,7 @@ } } }, -"revision": "20250916", +"revision": "20251021", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { @@ -521,6 +526,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json b/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json index e375ef49f1..7b4deaee7d 100644 --- a/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -373,6 +373,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta1/{+name}/operations", @@ -390,7 +395,7 @@ } } }, -"revision": "20250916", +"revision": "20251021", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { @@ -533,6 +538,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From c8e19f3f6ddeafea8e66e53e0b84b3239353b4c5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:17 +0000 Subject: [PATCH 69/70] feat(workflows): update the api #### workflows:v1 The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) #### workflows:v1beta The following keys were added: - resources.projects.resources.locations.resources.operations.methods.list.parameters.returnPartialSuccess (Total Keys: 2) - schemas.ListOperationsResponse.properties.unreachable (Total Keys: 2) --- ...workflows_v1.projects.locations.operations.html | 8 ++++++-- ...flows_v1beta.projects.locations.operations.html | 8 ++++++-- .../discovery_cache/documents/workflows.v1.json | 14 +++++++++++++- .../documents/workflows.v1beta.json | 14 +++++++++++++- 4 files changed, 38 insertions(+), 6 deletions(-) diff --git a/docs/dyn/workflows_v1.projects.locations.operations.html b/docs/dyn/workflows_v1.projects.locations.operations.html index 9de6419b35..57613e3f7a 100644 --- a/docs/dyn/workflows_v1.projects.locations.operations.html +++ b/docs/dyn/workflows_v1.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -157,6 +157,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -188,6 +189,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/docs/dyn/workflows_v1beta.projects.locations.operations.html b/docs/dyn/workflows_v1beta.projects.locations.operations.html index 23ed521ff9..26a59a458a 100644 --- a/docs/dyn/workflows_v1beta.projects.locations.operations.html +++ b/docs/dyn/workflows_v1beta.projects.locations.operations.html @@ -84,7 +84,7 @@

Instance Methods

get(name, x__xgafv=None)

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.

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

list_next()

@@ -149,7 +149,7 @@

Method Details

- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) 
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
 
 Args:
@@ -157,6 +157,7 @@ 
Method Details

   filter: string, The standard list filter.
   pageSize: integer, The standard list page size.
   pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -188,6 +189,9 @@ 
Method Details

       },
     },
   ],
+  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.
+    "A String",
+  ],
 }
diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index 61ec5c7c59..4385897218 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -266,6 +266,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+name}/operations", @@ -491,7 +496,7 @@ } } }, -"revision": "20250916", +"revision": "20251013", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -532,6 +537,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/workflows.v1beta.json b/googleapiclient/discovery_cache/documents/workflows.v1beta.json index 65899843e5..6158ee1dea 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1beta.json @@ -266,6 +266,11 @@ "description": "The standard list page token.", "location": "query", "type": "string" +}, +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, "path": "v1beta/{+name}/operations", @@ -450,7 +455,7 @@ } } }, -"revision": "20250916", +"revision": "20251013", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -491,6 +496,13 @@ "$ref": "Operation" }, "type": "array" +}, +"unreachable": { +"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" From a42d9228a73c5a24b1c9b4b3123679ceed444914 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 4 Nov 2025 07:10:17 +0000 Subject: [PATCH 70/70] chore(docs): Add new discovery artifacts and artifacts with minor updates --- .../dyn/apigateway_v1.projects.locations.html | 2 +- .../apigateway_v1beta.projects.locations.html | 2 +- docs/dyn/apim_v1alpha.projects.locations.html | 2 +- ...bleadmin_v2.projects.instances.tables.html | 16 +- .../bigtableadmin_v2.projects.locations.html | 2 +- docs/dyn/chromewebstore_v2.html | 116 ++ docs/dyn/chromewebstore_v2.media.html | 119 ++ docs/dyn/chromewebstore_v2.publishers.html | 91 ++ .../chromewebstore_v2.publishers.items.html | 223 +++ .../dyn/cloudbuild_v2.projects.locations.html | 2 +- .../clouddeploy_v1.projects.locations.html | 2 +- ...dlocationfinder_v1.projects.locations.html | 2 +- ...tionfinder_v1alpha.projects.locations.html | 2 +- .../dyn/cloudtasks_v2.projects.locations.html | 2 +- ...cloudtasks_v2beta2.projects.locations.html | 2 +- ...cloudtasks_v2beta3.projects.locations.html | 2 +- ...iplatform_v1alpha1.projects.locations.html | 2 +- docs/dyn/docs_v1.documents.html | 1222 ++++++++--------- docs/dyn/eventarc_v1.projects.locations.html | 2 +- ....projects.locations.publishers.models.html | 966 ++++++------- docs/dyn/firestore_v1.projects.locations.html | 2 +- docs/dyn/gkehub_v1.projects.locations.html | 2 +- .../gkehub_v1alpha.projects.locations.html | 2 +- .../dyn/gkehub_v1beta.projects.locations.html | 2 +- .../gkehub_v1beta1.projects.locations.html | 2 +- docs/dyn/gkehub_v2.projects.locations.html | 2 +- .../gkehub_v2alpha.projects.locations.html | 2 +- .../dyn/gkehub_v2beta.projects.locations.html | 2 +- docs/dyn/identitytoolkit_v1.accounts.html | 8 +- docs/dyn/metastore_v1.projects.locations.html | 2 +- .../metastore_v1alpha.projects.locations.html | 2 +- .../metastore_v1beta.projects.locations.html | 2 +- docs/dyn/netapp_v1.projects.locations.html | 2 +- ...tapp_v1.projects.locations.kmsConfigs.html | 8 +- .../netapp_v1beta1.projects.locations.html | 2 +- ...v1beta1.projects.locations.kmsConfigs.html | 8 +- ...nectivity_v1alpha1.projects.locations.html | 2 +- ...management_v1.organizations.locations.html | 2 +- ...tworkmanagement_v1.projects.locations.html | 2 +- ...ement_v1beta1.organizations.locations.html | 2 +- ...management_v1beta1.projects.locations.html | 2 +- .../observability_v1.projects.locations.html | 2 +- .../oracledatabase_v1.projects.locations.html | 2 +- .../parallelstore_v1.projects.locations.html | 2 +- ...rallelstore_v1beta.projects.locations.html | 2 +- docs/dyn/privateca_v1.projects.locations.html | 2 +- .../privateca_v1beta1.projects.locations.html | 2 +- ...chaenterprise_v1.projects.assessments.html | 8 +- ...der_v1beta1.billingAccounts.locations.html | 2 +- ...recommender_v1beta1.folders.locations.html | 2 +- ...ender_v1beta1.organizations.locations.html | 2 +- ...ecommender_v1beta1.projects.locations.html | 2 +- docs/dyn/run_v1.projects.locations.html | 2 +- ...ervicedirectory_v1.projects.locations.html | 2 +- ...edirectory_v1beta1.projects.locations.html | 2 +- ...servicemanagement_v1.services.configs.html | 8 +- docs/dyn/servicemanagement_v1.services.html | 2 +- ...batchoperations_v1.projects.locations.html | 2 +- docs/dyn/travelimpactmodel_v1.flights.html | 20 +- ...ations.evaluations.executions.results.html | 2 +- ...workloadmanager_v1.projects.locations.html | 2 +- .../documents/androidmanagement.v1.json | 4 +- .../documents/apigateway.v1.json | 4 +- .../documents/apigateway.v1beta.json | 4 +- .../documents/apim.v1alpha.json | 4 +- .../discovery_cache/documents/batch.v1.json | 16 +- .../documents/bigtableadmin.v2.json | 6 +- .../businessprofileperformance.v1.json | 44 +- .../documents/chromewebstore.v2.json | 550 ++++++++ .../documents/cloudbuild.v2.json | 4 +- .../documents/clouddeploy.v1.json | 4 +- .../documents/cloudlocationfinder.v1.json | 4 +- .../cloudlocationfinder.v1alpha.json | 4 +- .../documents/cloudtasks.v2.json | 4 +- .../documents/cloudtasks.v2beta2.json | 4 +- .../documents/cloudtasks.v2beta3.json | 4 +- .../contactcenteraiplatform.v1alpha1.json | 4 +- .../documents/deploymentmanager.alpha.json | 23 +- .../documents/deploymentmanager.v2.json | 23 +- .../documents/deploymentmanager.v2beta.json | 23 +- .../discovery_cache/documents/docs.v1.json | 72 +- .../documents/eventarc.v1.json | 4 +- .../documents/firebaseml.v2beta.json | 468 +++---- .../documents/firestore.v1.json | 4 +- .../discovery_cache/documents/gkehub.v1.json | 4 +- .../documents/gkehub.v1alpha.json | 4 +- .../documents/gkehub.v1beta.json | 4 +- .../documents/gkehub.v1beta1.json | 4 +- .../discovery_cache/documents/gkehub.v2.json | 4 +- .../documents/gkehub.v2alpha.json | 4 +- .../documents/gkehub.v2beta.json | 4 +- .../documents/identitytoolkit.v1.json | 10 +- .../documents/language.v1.json | 174 ++- .../documents/language.v1beta2.json | 174 ++- .../documents/language.v2.json | 174 ++- .../documents/metastore.v1.json | 4 +- .../documents/metastore.v1alpha.json | 4 +- .../documents/metastore.v1beta.json | 4 +- .../documents/mybusinessplaceactions.v1.json | 14 +- .../discovery_cache/documents/netapp.v1.json | 6 +- .../documents/netapp.v1beta1.json | 6 +- .../networkconnectivity.v1alpha1.json | 4 +- .../documents/networkmanagement.v1.json | 6 +- .../documents/networkmanagement.v1beta1.json | 6 +- .../documents/observability.v1.json | 4 +- .../documents/oracledatabase.v1.json | 4 +- .../documents/parallelstore.v1.json | 4 +- .../documents/parallelstore.v1beta.json | 4 +- .../documents/privateca.v1.json | 4 +- .../documents/privateca.v1beta1.json | 4 +- .../documents/recaptchaenterprise.v1.json | 12 +- .../documents/recommender.v1beta1.json | 10 +- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 2 +- .../documents/servicedirectory.v1.json | 4 +- .../documents/servicedirectory.v1beta1.json | 4 +- .../documents/servicemanagement.v1.json | 4 +- .../documents/servicenetworking.v1.json | 4 +- .../documents/servicenetworking.v1beta.json | 4 +- .../discovery_cache/documents/spanner.v1.json | 10 +- .../documents/storagebatchoperations.v1.json | 4 +- .../documents/travelimpactmodel.v1.json | 12 +- .../documents/workloadmanager.v1.json | 6 +- 123 files changed, 3293 insertions(+), 1615 deletions(-) create mode 100644 docs/dyn/chromewebstore_v2.html create mode 100644 docs/dyn/chromewebstore_v2.media.html create mode 100644 docs/dyn/chromewebstore_v2.publishers.html create mode 100644 docs/dyn/chromewebstore_v2.publishers.items.html create mode 100644 googleapiclient/discovery_cache/documents/chromewebstore.v2.json diff --git a/docs/dyn/apigateway_v1.projects.locations.html b/docs/dyn/apigateway_v1.projects.locations.html index bca7d8e357..132185865e 100644 --- a/docs/dyn/apigateway_v1.projects.locations.html +++ b/docs/dyn/apigateway_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/apigateway_v1beta.projects.locations.html b/docs/dyn/apigateway_v1beta.projects.locations.html index e317abbeb5..7cacab5f46 100644 --- a/docs/dyn/apigateway_v1beta.projects.locations.html +++ b/docs/dyn/apigateway_v1beta.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html index d13dcafe11..cbc5b397ba 100644 --- a/docs/dyn/apim_v1alpha.projects.locations.html +++ b/docs/dyn/apim_v1alpha.projects.locations.html @@ -172,7 +172,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index bac6ce2303..5a877c9694 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -232,7 +232,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -438,7 +438,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -727,7 +727,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1008,7 +1008,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1205,7 +1205,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1330,7 +1330,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1495,7 +1495,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1701,7 +1701,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, diff --git a/docs/dyn/bigtableadmin_v2.projects.locations.html b/docs/dyn/bigtableadmin_v2.projects.locations.html index 5d8d55bee8..16b7c6335d 100644 --- a/docs/dyn/bigtableadmin_v2.projects.locations.html +++ b/docs/dyn/bigtableadmin_v2.projects.locations.html @@ -95,7 +95,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/chromewebstore_v2.html b/docs/dyn/chromewebstore_v2.html new file mode 100644 index 0000000000..3fde03a33a --- /dev/null +++ b/docs/dyn/chromewebstore_v2.html @@ -0,0 +1,116 @@ + + + +

Chrome Web Store API

+

Instance Methods

+

+ media() +

+

Returns the media Resource.

+ +

+ publishers() +

+

Returns the publishers Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ new_batch_http_request() + 
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/chromewebstore_v2.media.html b/docs/dyn/chromewebstore_v2.media.html new file mode 100644 index 0000000000..a458464b47 --- /dev/null +++ b/docs/dyn/chromewebstore_v2.media.html @@ -0,0 +1,119 @@ + + + +

Chrome Web Store API . media

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ upload(name, body=None, media_body=None, media_mime_type=None, x__xgafv=None)

+

Upload a new package to an existing item.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ upload(name, body=None, media_body=None, media_mime_type=None, x__xgafv=None) + 
Upload a new package to an existing item.
+
+Args:
+  name: string, Required. Name of the item to upload the new package to in the form `publishers/{publisherId}/items/{itemId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UploadItemPackage.
+}
+
+  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
+  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `UploadItemPackage`.
+  "crxVersion": "A String", # The extension version provided in the manifest of the uploaded package. This will not be set if the upload is still in progress (`upload_state` is `UPLOAD_IN_PROGRESS`).
+  "itemId": "A String", # Output only. The ID of the item the package was uploaded to.
+  "name": "A String", # The name of the item the package was uploaded to.
+  "uploadState": "A String", # Output only. The state of the upload. If `upload_state` is `UPLOAD_IN_PROGRESS`, you can poll for updates using the fetchStatus method.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/chromewebstore_v2.publishers.html b/docs/dyn/chromewebstore_v2.publishers.html new file mode 100644 index 0000000000..cde1085995 --- /dev/null +++ b/docs/dyn/chromewebstore_v2.publishers.html @@ -0,0 +1,91 @@ + + + +

Chrome Web Store API . publishers

+

Instance Methods

+

+ items() +

+

Returns the items Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/chromewebstore_v2.publishers.items.html b/docs/dyn/chromewebstore_v2.publishers.items.html new file mode 100644 index 0000000000..4602342485 --- /dev/null +++ b/docs/dyn/chromewebstore_v2.publishers.items.html @@ -0,0 +1,223 @@ + + + +

Chrome Web Store API . publishers . items

+

Instance Methods

+

+ cancelSubmission(name, body=None, x__xgafv=None)

+

Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.

+

+ close()

+

Close httplib2 connections.

+

+ fetchStatus(name, x__xgafv=None)

+

Fetch the status of an item.

+

+ publish(name, body=None, x__xgafv=None)

+

Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.

+

+ setPublishedDeployPercentage(name, body=None, x__xgafv=None)

+

Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.

+

Method Details

+
+ cancelSubmission(name, body=None, x__xgafv=None) + 
Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.
+
+Args:
+  name: string, Required. Name of the item to cancel the submission of in the form `publishers/{publisherId}/items/{itemId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for CancelSubmission.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `CancelSubmission`.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ fetchStatus(name, x__xgafv=None) + 
Fetch the status of an item.
+
+Args:
+  name: string, Required. Name of the item to retrieve the status of in the form `publishers/{publisherId}/items/{itemId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `FetchItemStatus`.
+  "itemId": "A String", # Output only. The ID of the item.
+  "lastAsyncUploadState": "A String", # Output only. The state of the last async upload for an item. Only set when there has been an async upload for the item in the past 24 hours.
+  "name": "A String", # The name of the requested item.
+  "publicKey": "A String", # The public key of the item, which may be generated by the store.
+  "publishedItemRevisionStatus": { # Details on the status of an item revision. # Output only. Status of the current published revision of the item. Will be unset if the item is not published.
+    "distributionChannels": [ # Details on the package of the item
+      { # Deployment information for a specific release channel
+        "crxVersion": "A String", # The extension version provided in the manifest of the uploaded package.
+        "deployPercentage": 42, # The current deploy percentage for the release channel (nonnegative number between 0 and 100).
+      },
+    ],
+    "state": "A String", # Output only. Current state of the item
+  },
+  "submittedItemRevisionStatus": { # Details on the status of an item revision. # Status of the item revision submitted to be published. Will be unset if the item has not been submitted for publishing since the last successful publish.
+    "distributionChannels": [ # Details on the package of the item
+      { # Deployment information for a specific release channel
+        "crxVersion": "A String", # The extension version provided in the manifest of the uploaded package.
+        "deployPercentage": 42, # The current deploy percentage for the release channel (nonnegative number between 0 and 100).
+      },
+    ],
+    "state": "A String", # Output only. Current state of the item
+  },
+  "takenDown": True or False, # If true, the item has been taken down for a policy violation. Check the developer dashboard for details.
+  "warned": True or False, # If true, the item has been warned for a policy violation and will be taken down if not resolved. Check the developer dashboard for details.
+}
+
+ +
+ publish(name, body=None, x__xgafv=None) + 
Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.
+
+Args:
+  name: string, Required. Name of the item in the form `publishers/{publisherId}/items/{itemId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PublishItem.
+  "deployInfos": [ # Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset.
+    { # Deployment information for a specific release channel. Used in requests to update deployment parameters.
+      "deployPercentage": 42, # Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100).
+    },
+  ],
+  "publishType": "A String", # Optional. Use this to control if the item is published immediately on approval or staged for publishing in the future. Defaults to `DEFAULT_PUBLISH` if unset.
+  "skipReview": True or False, # Optional. Whether to attempt to skip item review. The API will validate if the item qualifies and return a validation error if the item requires review. Defaults to `false` if unset.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `PublishItem`.
+  "itemId": "A String", # Output only. The ID of the item.
+  "name": "A String", # The name of the item that was submitted
+  "state": "A String", # Output only. The current state of the submission.
+}
+
+ +
+ setPublishedDeployPercentage(name, body=None, x__xgafv=None) + 
Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.
+
+Args:
+  name: string, Required. Name of the item to update the published revision of in the form `publishers/{publisherId}/items/{itemId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SetPublishedDeployPercentage.
+  "deployPercentage": 42, # Required. Unscaled percentage value for the publised revision (nonnegative number between 0 and 100). It must be larger than the existing target percentage.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for `SetPublishedDeployPercentage`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/cloudbuild_v2.projects.locations.html b/docs/dyn/cloudbuild_v2.projects.locations.html index 8a7e902b52..61128fb3c0 100644 --- a/docs/dyn/cloudbuild_v2.projects.locations.html +++ b/docs/dyn/cloudbuild_v2.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.html b/docs/dyn/clouddeploy_v1.projects.locations.html index e10103193b..99f2b5e0e7 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.html @@ -185,7 +185,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudlocationfinder_v1.projects.locations.html b/docs/dyn/cloudlocationfinder_v1.projects.locations.html index 23d5ab7d1f..354858ec67 100644 --- a/docs/dyn/cloudlocationfinder_v1.projects.locations.html +++ b/docs/dyn/cloudlocationfinder_v1.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html b/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html index 1197d3c3fd..cf4c6e5cf8 100644 --- a/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html +++ b/docs/dyn/cloudlocationfinder_v1alpha.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudtasks_v2.projects.locations.html b/docs/dyn/cloudtasks_v2.projects.locations.html index 56e80ad167..867d2bd08e 100644 --- a/docs/dyn/cloudtasks_v2.projects.locations.html +++ b/docs/dyn/cloudtasks_v2.projects.locations.html @@ -156,7 +156,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudtasks_v2beta2.projects.locations.html b/docs/dyn/cloudtasks_v2beta2.projects.locations.html index 96ea061826..649b08f31f 100644 --- a/docs/dyn/cloudtasks_v2beta2.projects.locations.html +++ b/docs/dyn/cloudtasks_v2beta2.projects.locations.html @@ -156,7 +156,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/cloudtasks_v2beta3.projects.locations.html b/docs/dyn/cloudtasks_v2beta3.projects.locations.html index 3277c6634b..8f967e35a6 100644 --- a/docs/dyn/cloudtasks_v2beta3.projects.locations.html +++ b/docs/dyn/cloudtasks_v2beta3.projects.locations.html @@ -156,7 +156,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html index 5491c4a188..02ba4e74d4 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.html @@ -138,7 +138,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index 7b7308da44..61dbbf54af 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -237,11 +237,11 @@

Method Details

}, }, "insertPerson": { # Inserts a person mention. # Inserts a person mention. - "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the person at the end of a header, footer, footnote or the document body. + "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the person mention at the end of a header, footer, footnote or the document body. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, - "location": { # A particular location in the document. # Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. + "location": { # A particular location in the document. # Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. @@ -392,42 +392,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -437,9 +437,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. "tabId": "A String", # The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document. @@ -628,40 +628,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, }, "updateTableCellStyle": { # Updates the style of a range of table cells. # Updates the style of table cells. @@ -2546,40 +2546,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -2893,42 +2893,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -2938,9 +2938,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "footers": { # Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. "a_key": { # A document footer. @@ -4552,40 +4552,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -6498,40 +6498,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -8444,40 +8444,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -9620,42 +9620,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -9665,9 +9665,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. @@ -11569,40 +11569,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -11915,42 +11915,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -11960,9 +11960,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "footers": { # The footers in the document tab, keyed by footer ID. "a_key": { # A document footer. @@ -13574,40 +13574,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -15520,40 +15520,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -17466,40 +17466,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -18641,42 +18641,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -18686,9 +18686,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. @@ -20606,40 +20606,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -20953,42 +20953,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -20998,9 +20998,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "footers": { # Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. "a_key": { # A document footer. @@ -22612,40 +22612,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -24558,40 +24558,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -26504,40 +26504,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -27680,42 +27680,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -27725,9 +27725,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. @@ -29629,40 +29629,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -29975,42 +29975,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -30020,9 +30020,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "footers": { # The footers in the document tab, keyed by footer ID. "a_key": { # A document footer. @@ -31634,40 +31634,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -33580,40 +33580,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -35526,40 +35526,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -36701,42 +36701,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -36746,9 +36746,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. @@ -38680,40 +38680,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -39027,42 +39027,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -39072,9 +39072,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "footers": { # Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. "a_key": { # A document footer. @@ -40686,40 +40686,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -42632,40 +42632,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -44578,40 +44578,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -45754,42 +45754,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -45799,9 +45799,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. @@ -47703,40 +47703,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -48049,42 +48049,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -48094,9 +48094,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "footers": { # The footers in the document tab, keyed by footer ID. "a_key": { # A document footer. @@ -49708,40 +49708,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -51654,40 +51654,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -53600,40 +53600,40 @@

Method Details

], "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", @@ -54775,42 +54775,42 @@

Method Details

}, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. "documentFormat": { # Represents document-level format settings. # Specifies document-level format settings, such as the document mode (pages vs pageless). "documentMode": "A String", # Whether the document has pages or is pageless. }, - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered. + "pageSize": { # A width and height. # The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -54820,9 +54820,9 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. diff --git a/docs/dyn/eventarc_v1.projects.locations.html b/docs/dyn/eventarc_v1.projects.locations.html index 9ed70c67af..d1efcdbb23 100644 --- a/docs/dyn/eventarc_v1.projects.locations.html +++ b/docs/dyn/eventarc_v1.projects.locations.html @@ -205,7 +205,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 89fef8cc8a..da26d4054c 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -103,30 +103,30 @@

Method Details

{ # Request message for PredictionService.CountTokens. "contents": [ # Optional. Input content. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -147,30 +147,30 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config that the model will use to generate the response. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config that the model will use to generate the response. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. "compressionQuality": 42, # Optional. The compression quality of the output image. @@ -178,20 +178,20 @@

Method Details

}, "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -230,74 +230,74 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -318,22 +318,22 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). @@ -341,7 +341,7 @@

Method Details

}, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. "A String", ], }, @@ -558,9 +558,9 @@

Method Details

{ # Response message for PredictionService.CountTokens. "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalBillableCharacters": 42, # The total number of billable characters counted across all instances from the request. @@ -580,30 +580,30 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -624,30 +624,30 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. "compressionQuality": 42, # Optional. The compression quality of the output image. @@ -655,20 +655,20 @@

Method Details

}, "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -707,84 +707,84 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -805,22 +805,22 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -843,7 +843,7 @@

Method Details

}, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. "A String", ], }, @@ -1061,47 +1061,47 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -1122,137 +1122,137 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -1264,46 +1264,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. @@ -1324,30 +1324,30 @@

Method Details

{ # Request message for [PredictionService.GenerateContent]. "cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` "contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. - { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -1368,30 +1368,30 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, ], - "generationConfig": { # Generation config. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamp will be included in the request to the model. - "candidateCount": 42, # Optional. Number of candidates to generate. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. - "frequencyPenalty": 3.14, # Optional. Frequency penalties. - "imageConfig": { # Config for image generation features. # Optional. Config for image generation features. + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. "compressionQuality": 42, # Optional. The compression quality of the output image. @@ -1399,20 +1399,20 @@

Method Details

}, "personGeneration": "A String", # Optional. Controls whether the model can generate people. }, - "logprobs": 42, # Optional. Logit probabilities. - "maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message. - "mediaResolution": "A String", # Optional. If specified, the media resolution specified will be used. + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. "modelConfig": { # Config for model selection. # Optional. Config for model selection. "featureSelectionPreference": "A String", # Required. Feature selection preference. }, - "presencePenalty": 3.14, # Optional. Positive penalties. - "responseJsonSchema": "", # Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set. - "responseLogprobs": True or False, # Optional. If true, export the logprobs results in response. - "responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. - "responseModalities": [ # Optional. The modalities of the response. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. "A String", ], - "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. + "responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may be added in the future as needed. # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. "additionalProperties": "", # Optional. Can either be a boolean or an object; controls the presence of additional properties. "anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list. # Object with schema name: GoogleCloudAiplatformV1beta1Schema @@ -1451,84 +1451,84 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, - "routingConfig": { # The configuration for routing the request to a specific model. # Optional. Routing configuration. - "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. "modelRoutingPreference": "A String", # The model routing preference. }, - "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. - "modelName": "A String", # The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. }, }, - "seed": 42, # Optional. Seed. - "speechConfig": { # The speech generation config. # Optional. The speech generation config. - "languageCode": "A String", # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi speaker setup. + { # Configuration for a single speaker in a multi-speaker setup. "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # The configuration for the voice to use. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, ], }, - "voiceConfig": { # The configuration for the voice to use. # The configuration for the speaker to use. - "prebuiltVoiceConfig": { # The configuration for the prebuilt speaker to use. # The configuration for the prebuilt voice to use. - "voiceName": "A String", # The name of the preset voice to use. + "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. }, }, }, - "stopSequences": [ # Optional. Stop sequences. + "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. "A String", ], - "temperature": 3.14, # Optional. Controls the randomness of predictions. - "thinkingConfig": { # Config for thinking features. # Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking. - "includeThoughts": True or False, # Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available. - "thinkingBudget": 42, # Optional. Indicates the thinking budget in tokens. + "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. + "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking. + "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available. + "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency. }, - "topK": 3.14, # Optional. If specified, top-k sampling will be used. - "topP": 3.14, # Optional. If specified, nucleus sampling will be used. + "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words. + "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both. }, "labels": { # Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. "a_key": "A String", }, - "modelArmorConfig": { # Configuration for Model Armor integrations of prompt and responses. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. - "promptTemplateName": "A String", # Optional. The name of the Model Armor template to use for prompt sanitization. - "responseTemplateName": "A String", # Optional. The name of the Model Armor template to use for response sanitization. + "modelArmorConfig": { # Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. # Optional. Settings for prompt and response sanitization using the Model Armor service. If supplied, safety_settings must not be supplied. + "promptTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. + "responseTemplateName": "A String", # Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`. }, "safetySettings": [ # Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. - { # Safety settings. - "category": "A String", # Required. Harm category. - "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score. - "threshold": "A String", # Required. The harm block threshold. + { # A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category. + "category": "A String", # Required. The harm category to be blocked. + "method": "A String", # Optional. The method for blocking content. If not specified, the default behavior is to use the probability score. + "threshold": "A String", # Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked. }, ], - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "systemInstruction": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -1549,22 +1549,22 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, "toolConfig": { # Tool config. This config is shared for all tools provided in the request. # Optional. Tool config. This config is shared for all tools provided in the request. "functionCallingConfig": { # Function calling config. # Optional. Function calling config. @@ -1587,7 +1587,7 @@

Method Details

}, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. "environment": "A String", # Required. The environment being operated. - "excludedPredefinedFunctions": [ # Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. "A String", ], }, @@ -1805,47 +1805,47 @@

Method Details

{ # Response message for [PredictionService.GenerateContent]. "candidates": [ # Output only. Generated candidates. { # A response candidate generated from the model. - "avgLogprobs": 3.14, # Output only. Average log probability score of the candidate. - "citationMetadata": { # A collection of source attributions for a piece of content. # Output only. Source attribution of the generated content. - "citations": [ # Output only. List of citations. - { # Source attributions for content. - "endIndex": 42, # Output only. End index into the content. - "license": "A String", # Output only. License of the attribution. - "publicationDate": { # 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 # Output only. Publication date of the attribution. + "avgLogprobs": 3.14, # Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response. + "citationMetadata": { # A collection of citations that apply to a piece of generated content. # Output only. A collection of citations that apply to the generated content. + "citations": [ # Output only. A list of citations for the content. + { # A citation for a piece of generatedcontent. + "endIndex": 42, # Output only. The end index of the citation in the content. + "license": "A String", # Output only. The license of the source of the citation. + "publicationDate": { # 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 # Output only. The publication date of the source of the citation. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "startIndex": 42, # Output only. Start index into the content. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. Url reference of the attribution. + "startIndex": 42, # Output only. The start index of the citation in the content. + "title": "A String", # Output only. The title of the source of the citation. + "uri": "A String", # Output only. The URI of the source of the citation. }, ], }, - "content": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Output only. Content parts of the candidate. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. Result of executing the [ExecutableCode]. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Output only. The content of the candidate. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the [ExecutableCode]. Only generated when using the [CodeExecution] tool, and always follows a `part` containing the [ExecutableCode]. # Optional. The result of executing the ExecutableCode. "outcome": "A String", # Required. Outcome of the code execution. "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is meant to be executed. + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the [CodeExecution] tool, in which the code will be automatically executed, and a corresponding [CodeExecutionResult] will also be generated. # Optional. Code generated by the model that is intended to be executed. "code": "A String", # Required. The code to be executed. "language": "A String", # Required. Programming language of the `code`. }, - "fileData": { # URI based data. # Optional. URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. "args": { # Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. "a_key": "", # Properties of the object. }, "id": "A String", # Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. "name": "A String", # Optional. The name of the function to call. Matches [FunctionDeclaration.name]. }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. "id": "A String", # Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. @@ -1866,137 +1866,137 @@

Method Details

"a_key": "", # Properties of the object. }, }, - "inlineData": { # Content blob. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, - "text": "A String", # Optional. Text part (can be code). - "thought": True or False, # Optional. Indicates if the part is thought from the model. + "text": "A String", # Optional. The text content of the part. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0]. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. "startOffset": "A String", # Optional. The start offset of the video. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. - "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. - "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "googleMapsWidgetContextToken": "A String", # Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding. - "groundingChunks": [ # List of supporting references retrieved from specified grounding source. - { # Grounding chunk. - "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. - "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. - { # Encapsulates a review snippet. + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "finishMessage": "A String", # Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set. + "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating. + "groundingMetadata": { # Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. # Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content. + "googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps. + "groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps. + { # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information. + "maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details. + "placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. + "reviewSnippets": [ # Snippets of reviews that were used to generate the answer. + { # A review snippet that is used to generate the answer. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "reviewId": "A String", # Id of the review referencing the place. - "title": "A String", # Title of the review. + "reviewId": "A String", # The ID of the review that is being referenced. + "title": "A String", # The title of the review. }, ], }, - "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the place answer. - "title": "A String", # Title of the place. - "uri": "A String", # URI reference of the place. - }, - "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. - "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. - "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool. + "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API. + "text": "A String", # The text of the place answer. + "title": "A String", # The title of the place. + "uri": "A String", # The URI of the place. + }, + "retrievedContext": { # Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset. # A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details + "documentName": "A String", # Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. + "ragChunk": { # A RagChunk includes the content of a chunk of a RagFile, and associated metadata. # Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used. "pageSpan": { # Represents where the chunk starts and ends in the document. # If populated, represents where the chunk starts and ends in the document. "firstPage": 42, # Page where chunk starts in the document. Inclusive. 1-indexed. "lastPage": 42, # Page where chunk ends in the document. Inclusive. 1-indexed. }, "text": "A String", # The content of the chunk. }, - "text": "A String", # Text of the attribution. - "title": "A String", # Title of the attribution. - "uri": "A String", # URI reference of the attribution. + "text": "A String", # The content of the retrieved data source. + "title": "A String", # The title of the retrieved data source. + "uri": "A String", # The URI of the retrieved data source. }, - "web": { # Chunk from the web. # Grounding chunk from the web. - "domain": "A String", # Domain of the (original) URI. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "web": { # A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information. # A grounding chunk from a web page, typically from Google Search. See the `Web` message for details. + "domain": "A String", # The domain of the web page that contains the evidence. This can be used to filter out low-quality sources. + "title": "A String", # The title of the web page that contains the evidence. + "uri": "A String", # The URI of the web page that contains the evidence. }, }, ], - "groundingSupports": [ # Optional. List of grounding support. - { # Grounding support. - "confidenceScores": [ # Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored. + "groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search. + { # A collection of supporting references for a segment of the model's response. + "confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored. 3.14, ], - "groundingChunkIndices": [ # A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + "groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment. 42, ], - "segment": { # Segment of the content. # Segment of the content this support belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. + "segment": { # A segment of the content. # The content segment that this support message applies to. + "endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index. + "partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content. + "startIndex": 42, # Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment. + "text": "A String", # Output only. The text of the segment. }, }, ], - "retrievalMetadata": { # Metadata related to retrieval in the grounding flow. # Optional. Output only. Retrieval metadata. - "googleSearchDynamicRetrievalScore": 3.14, # Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + "retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source. + "googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search. }, - "retrievalQueries": [ # Optional. Queries executed by the retrieval tools. + "retrievalQueries": [ # Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search. "A String", ], - "searchEntryPoint": { # Google search entry point. # Optional. Google search entry for the following-up web searches. - "renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. - "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. + "searchEntryPoint": { # An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application. # Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search. + "renderedContent": "A String", # Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result. + "sdkBlob": "A String", # Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI. }, - "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. - { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. - "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). - "sourceId": "A String", # Id of the place or review. + "sourceFlaggingUris": [ # Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps. + { # A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps. + "flagContentUri": "A String", # The URI that can be used to flag the content. + "sourceId": "A String", # The ID of the place or review. }, ], - "webSearchQueries": [ # Optional. Web search queries for the following-up web search. + "webSearchQueries": [ # Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search. "A String", ], }, - "index": 42, # Output only. Index of the candidate. - "logprobsResult": { # Logprobs Result # Output only. Log-likelihood scores for the response tokens and top tokens - "chosenCandidates": [ # Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "index": 42, # Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1. + "logprobsResult": { # The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is "hallucinating" or generating factually incorrect information. # Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential "hallucinations". + "chosenCandidates": [ # A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], - "topCandidates": [ # Length = total number of decoding steps. - { # Candidates with top log probabilities at each decoding step. - "candidates": [ # Sorted by log probability in descending order. - { # Candidate for the logprobs token and score. - "logProbability": 3.14, # The candidate's log probability. - "token": "A String", # The candidate's token string value. - "tokenId": 42, # The candidate's token id value. + "topCandidates": [ # A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. + { # A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered. + "candidates": [ # The list of candidate tokens, sorted by log probability in descending order. + { # A single token and its associated log probability. + "logProbability": 3.14, # The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. + "token": "A String", # The token's string representation. + "tokenId": 42, # The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. }, ], }, ], }, - "safetyRatings": [ # Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + "safetyRatings": [ # Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], - "urlContextMetadata": { # Metadata related to url context retrieval tool. # Output only. Metadata related to url context retrieval tool. - "urlMetadata": [ # Output only. List of url context. - { # Context of the a single url retrieval. - "retrievedUrl": "A String", # Retrieved url by the tool. - "urlRetrievalStatus": "A String", # Status of the url retrieval. + "urlContextMetadata": { # Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. # Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL. + "urlMetadata": [ # Output only. A list of URL metadata, with one entry for each URL retrieved by the tool. + { # The metadata for a single URL retrieval. + "retrievedUrl": "A String", # The URL retrieved by the tool. + "urlRetrievalStatus": "A String", # The status of the URL retrieval. }, ], }, @@ -2008,46 +2008,46 @@

Method Details

"blockReason": "A String", # Output only. The reason why the prompt was blocked. "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. - { # Safety rating corresponding to the generated content. - "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. - "category": "A String", # Output only. Harm category. + { # A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level. + "blocked": True or False, # Output only. Indicates whether the content was blocked because of this rating. + "category": "A String", # Output only. The harm category of this rating. "overwrittenThreshold": "A String", # Output only. The overwritten threshold for the safety category of Gemini 2.0 image out. If minors are detected in the output image, the threshold of each safety category will be overwritten if user sets a lower threshold. - "probability": "A String", # Output only. Harm probability levels in the content. - "probabilityScore": 3.14, # Output only. Harm probability score. - "severity": "A String", # Output only. Harm severity levels in the content. - "severityScore": 3.14, # Output only. Harm severity score. + "probability": "A String", # Output only. The probability of harm for this category. + "probabilityScore": 3.14, # Output only. The probability score of harm for this category. + "severity": "A String", # Output only. The severity of harm for this category. + "severityScore": 3.14, # Output only. The severity score of harm for this category. }, ], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. - { # Represents token counting info for a single modality. - "modality": "A String", # The modality associated with this token count. - "tokenCount": 42, # Number of tokens. + { # Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes. + "modality": "A String", # The modality that this token count applies to. + "tokenCount": 42, # The number of tokens counted for this modality. }, ], "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. diff --git a/docs/dyn/firestore_v1.projects.locations.html b/docs/dyn/firestore_v1.projects.locations.html index d4dd57c711..90230bdeb9 100644 --- a/docs/dyn/firestore_v1.projects.locations.html +++ b/docs/dyn/firestore_v1.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v1.projects.locations.html b/docs/dyn/gkehub_v1.projects.locations.html index 04a1def72c..315c864361 100644 --- a/docs/dyn/gkehub_v1.projects.locations.html +++ b/docs/dyn/gkehub_v1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.html b/docs/dyn/gkehub_v1alpha.projects.locations.html index efd816d385..a45fb77b8f 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.html b/docs/dyn/gkehub_v1beta.projects.locations.html index a446756429..cdb22c21aa 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v1beta1.projects.locations.html b/docs/dyn/gkehub_v1beta1.projects.locations.html index b27fd67027..3ef3722a72 100644 --- a/docs/dyn/gkehub_v1beta1.projects.locations.html +++ b/docs/dyn/gkehub_v1beta1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v2.projects.locations.html b/docs/dyn/gkehub_v2.projects.locations.html index f1d532f294..a4cc212be3 100644 --- a/docs/dyn/gkehub_v2.projects.locations.html +++ b/docs/dyn/gkehub_v2.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v2alpha.projects.locations.html b/docs/dyn/gkehub_v2alpha.projects.locations.html index d39cb2b9c7..501400bb15 100644 --- a/docs/dyn/gkehub_v2alpha.projects.locations.html +++ b/docs/dyn/gkehub_v2alpha.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/gkehub_v2beta.projects.locations.html b/docs/dyn/gkehub_v2beta.projects.locations.html index 5517ca7442..fd1e06f678 100644 --- a/docs/dyn/gkehub_v2beta.projects.locations.html +++ b/docs/dyn/gkehub_v2beta.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/identitytoolkit_v1.accounts.html b/docs/dyn/identitytoolkit_v1.accounts.html index 0181356eaf..2ab9e6a97a 100644 --- a/docs/dyn/identitytoolkit_v1.accounts.html +++ b/docs/dyn/identitytoolkit_v1.accounts.html @@ -446,19 +446,19 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. +{ # Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator. "autoRetrievalInfo": { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval. "appSignatureHash": "A String", # The Android app's signature hash for Google Play Service's SMS Retriever API. }, "captchaResponse": "A String", # Optional. The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled. "clientType": "A String", # Optional. The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled. - "iosReceipt": "A String", # Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request. + "iosReceipt": "A String", # Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request. "iosSecret": "A String", # Secret delivered to iOS app as a push notification. Should be passed with an `ios_receipt` as well as the `x-ios-bundle-identifier` header. "phoneNumber": "A String", # The phone number to send the verification code to in E.164 format. "playIntegrityToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token (and safety_net_token). At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, , or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). A Play Integrity Token can be generated via the [PlayIntegrity API](https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce. - "recaptchaToken": "A String", # Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge. + "recaptchaToken": "A String", # Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge. "recaptchaVersion": "A String", # Optional. The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled. - "safetyNetToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce. + "safetyNetToken": "A String", # Android only. Safety Net has been deprecated. Please use play_integrity_token instead. "tenantId": "A String", # Tenant ID of the Identity Platform tenant the user is signing in to. } diff --git a/docs/dyn/metastore_v1.projects.locations.html b/docs/dyn/metastore_v1.projects.locations.html index eae51ccb0a..a5314c81db 100644 --- a/docs/dyn/metastore_v1.projects.locations.html +++ b/docs/dyn/metastore_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/metastore_v1alpha.projects.locations.html b/docs/dyn/metastore_v1alpha.projects.locations.html index 551fe6e070..2e0c4601ef 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/metastore_v1beta.projects.locations.html b/docs/dyn/metastore_v1beta.projects.locations.html index 93b159e733..b0d5fac24e 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.html +++ b/docs/dyn/metastore_v1beta.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/netapp_v1.projects.locations.html b/docs/dyn/netapp_v1.projects.locations.html index 6e22182abd..3ece00c9c9 100644 --- a/docs/dyn/netapp_v1.projects.locations.html +++ b/docs/dyn/netapp_v1.projects.locations.html @@ -160,7 +160,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html b/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html index 9db958565b..c8d5723c20 100644 --- a/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html +++ b/docs/dyn/netapp_v1.projects.locations.kmsConfigs.html @@ -118,7 +118,7 @@

Method Details

{ # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs @@ -252,7 +252,7 @@

Method Details

{ # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs @@ -287,7 +287,7 @@

Method Details

"kmsConfigs": [ # The list of KmsConfigs { # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs @@ -331,7 +331,7 @@

Method Details

{ # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs diff --git a/docs/dyn/netapp_v1beta1.projects.locations.html b/docs/dyn/netapp_v1beta1.projects.locations.html index b2d6d3c69e..4887e46102 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.html @@ -160,7 +160,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html b/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html index 01ac3ceadd..bd603c8e8b 100644 --- a/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html +++ b/docs/dyn/netapp_v1beta1.projects.locations.kmsConfigs.html @@ -118,7 +118,7 @@

Method Details

{ # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs @@ -252,7 +252,7 @@

Method Details

{ # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs @@ -287,7 +287,7 @@

Method Details

"kmsConfigs": [ # The list of KmsConfigs { # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs @@ -331,7 +331,7 @@

Method Details

{ # KmsConfig is the customer managed encryption key(CMEK) configuration. "createTime": "A String", # Output only. Create time of the KmsConfig. - "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}. + "cryptoKeyName": "A String", # Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}. "description": "A String", # Description of the KmsConfig. "instructions": "A String", # Output only. Instructions to provide the access to the customer provided encryption key. "labels": { # Labels as key value pairs diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html index 140acf8b79..b06f60cd3f 100644 --- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html +++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html @@ -145,7 +145,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/networkmanagement_v1.organizations.locations.html b/docs/dyn/networkmanagement_v1.organizations.locations.html index 7c153ffa1f..844d24c296 100644 --- a/docs/dyn/networkmanagement_v1.organizations.locations.html +++ b/docs/dyn/networkmanagement_v1.organizations.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.html b/docs/dyn/networkmanagement_v1.projects.locations.html index 219f23e68b..b5a0ea16f3 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/networkmanagement_v1beta1.organizations.locations.html b/docs/dyn/networkmanagement_v1beta1.organizations.locations.html index 1583ecfa07..c92e2771cf 100644 --- a/docs/dyn/networkmanagement_v1beta1.organizations.locations.html +++ b/docs/dyn/networkmanagement_v1beta1.organizations.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.html index f2bc0a1c98..f1cfb65837 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/observability_v1.projects.locations.html b/docs/dyn/observability_v1.projects.locations.html index 1b1e70330c..a75c7e7a01 100644 --- a/docs/dyn/observability_v1.projects.locations.html +++ b/docs/dyn/observability_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/oracledatabase_v1.projects.locations.html b/docs/dyn/oracledatabase_v1.projects.locations.html index 30aef0e153..1dcb1f3290 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.html @@ -220,7 +220,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/parallelstore_v1.projects.locations.html b/docs/dyn/parallelstore_v1.projects.locations.html index edd4436744..5860fcc61d 100644 --- a/docs/dyn/parallelstore_v1.projects.locations.html +++ b/docs/dyn/parallelstore_v1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/parallelstore_v1beta.projects.locations.html b/docs/dyn/parallelstore_v1beta.projects.locations.html index a688691f5e..cadd6a9949 100644 --- a/docs/dyn/parallelstore_v1beta.projects.locations.html +++ b/docs/dyn/parallelstore_v1beta.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/privateca_v1.projects.locations.html b/docs/dyn/privateca_v1.projects.locations.html index abb85a10a2..b8ca782f2f 100644 --- a/docs/dyn/privateca_v1.projects.locations.html +++ b/docs/dyn/privateca_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/privateca_v1beta1.projects.locations.html b/docs/dyn/privateca_v1beta1.projects.locations.html index 7dba0d382e..d13894bdd0 100644 --- a/docs/dyn/privateca_v1beta1.projects.locations.html +++ b/docs/dyn/privateca_v1beta1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index 138509b5d0..f6eb2aa48e 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -95,13 +95,13 @@

Method Details

{ # The request message to annotate an Assessment. "accountId": "A String", # Optional. A stable account identifier to apply to the assessment. This is an alternative to setting `account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. - "annotation": "A String", # Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. + "annotation": "A String", "hashedAccountId": "A String", # Optional. A stable hashed account identifier to apply to the assessment. This is an alternative to setting `hashed_account_id` in `CreateAssessment`, for example when a stable account identifier is not yet known in the initial request. "phoneAuthenticationEvent": { # Details on a phone authentication event # Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes. "eventTime": "A String", # Optional. The time at which the multi-factor authentication event (challenge or verification) occurred. "phoneNumber": "A String", # Required. Phone number in E.164 format for which a multi-factor authentication challenge was initiated, succeeded, or failed. }, - "reasons": [ # Optional. Reasons for the annotation that are assigned to the event. + "reasons": [ "A String", ], "transactionEvent": { # Describes an event in the lifecycle of a payment transaction. # Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction. @@ -158,7 +158,7 @@

Method Details

"username": "A String", # Username of the account that is being verified. Deprecated. Customers should now provide the `account_id` field in `event.user_info`. }, "assessmentEnvironment": { # The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. # Optional. The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. - "client": "A String", # Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - "wordpress.org/plugins/recaptcha-something" + "client": "A String", # Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "wordpress.org/plugins/recaptcha-something" "version": "A String", # Optional. The version of the client module. For example, "1.0.0". }, "event": { # The event being assessed. # Optional. The event being assessed. @@ -387,7 +387,7 @@

Method Details

"username": "A String", # Username of the account that is being verified. Deprecated. Customers should now provide the `account_id` field in `event.user_info`. }, "assessmentEnvironment": { # The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. # Optional. The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. - "client": "A String", # Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - "wordpress.org/plugins/recaptcha-something" + "client": "A String", # Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "wordpress.org/plugins/recaptcha-something" "version": "A String", # Optional. The version of the client module. For example, "1.0.0". }, "event": { # The event being assessed. # Optional. The event being assessed. diff --git a/docs/dyn/recommender_v1beta1.billingAccounts.locations.html b/docs/dyn/recommender_v1beta1.billingAccounts.locations.html index 996a9ac56f..aa03d8ae23 100644 --- a/docs/dyn/recommender_v1beta1.billingAccounts.locations.html +++ b/docs/dyn/recommender_v1beta1.billingAccounts.locations.html @@ -105,7 +105,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/recommender_v1beta1.folders.locations.html b/docs/dyn/recommender_v1beta1.folders.locations.html index 4342e60dcf..bdf198894c 100644 --- a/docs/dyn/recommender_v1beta1.folders.locations.html +++ b/docs/dyn/recommender_v1beta1.folders.locations.html @@ -105,7 +105,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/recommender_v1beta1.organizations.locations.html b/docs/dyn/recommender_v1beta1.organizations.locations.html index ecc9f79a56..1a7b54336a 100644 --- a/docs/dyn/recommender_v1beta1.organizations.locations.html +++ b/docs/dyn/recommender_v1beta1.organizations.locations.html @@ -105,7 +105,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/recommender_v1beta1.projects.locations.html b/docs/dyn/recommender_v1beta1.projects.locations.html index bf178ffdb0..931cedcd08 100644 --- a/docs/dyn/recommender_v1beta1.projects.locations.html +++ b/docs/dyn/recommender_v1beta1.projects.locations.html @@ -105,7 +105,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/run_v1.projects.locations.html b/docs/dyn/run_v1.projects.locations.html index 91c9222043..9dbc5e0522 100644 --- a/docs/dyn/run_v1.projects.locations.html +++ b/docs/dyn/run_v1.projects.locations.html @@ -140,7 +140,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/servicedirectory_v1.projects.locations.html b/docs/dyn/servicedirectory_v1.projects.locations.html index 9b1c0d3e6d..4a32641b3d 100644 --- a/docs/dyn/servicedirectory_v1.projects.locations.html +++ b/docs/dyn/servicedirectory_v1.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/servicedirectory_v1beta1.projects.locations.html b/docs/dyn/servicedirectory_v1beta1.projects.locations.html index a62dc9511d..bd19abd5fa 100644 --- a/docs/dyn/servicedirectory_v1beta1.projects.locations.html +++ b/docs/dyn/servicedirectory_v1beta1.projects.locations.html @@ -130,7 +130,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index 1888af2775..a1dbe9519a 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -244,7 +244,7 @@

Method Details

], }, "control": { # Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com # Configuration for the service control plane. - "environment": "A String", # The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + "environment": "A String", # The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. "methodPolicies": [ # Defines policies applying to the API methods of the service. { # Defines policies applying to an RPC method. "requestPolicies": [ # Policies that are applicable to the request message. @@ -950,7 +950,7 @@

Method Details

], }, "control": { # Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com # Configuration for the service control plane. - "environment": "A String", # The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + "environment": "A String", # The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. "methodPolicies": [ # Defines policies applying to the API methods of the service. { # Defines policies applying to an RPC method. "requestPolicies": [ # Policies that are applicable to the request message. @@ -1668,7 +1668,7 @@

Method Details

], }, "control": { # Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com # Configuration for the service control plane. - "environment": "A String", # The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + "environment": "A String", # The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. "methodPolicies": [ # Defines policies applying to the API methods of the service. { # Defines policies applying to an RPC method. "requestPolicies": [ # Policies that are applicable to the request message. @@ -2386,7 +2386,7 @@

Method Details

], }, "control": { # Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com # Configuration for the service control plane. - "environment": "A String", # The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + "environment": "A String", # The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. "methodPolicies": [ # Defines policies applying to the API methods of the service. { # Defines policies applying to an RPC method. "requestPolicies": [ # Policies that are applicable to the request message. diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index 5684bfcc73..368e541f70 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -439,7 +439,7 @@

Method Details

], }, "control": { # Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com # Configuration for the service control plane. - "environment": "A String", # The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com + "environment": "A String", # The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com. "methodPolicies": [ # Defines policies applying to the API methods of the service. { # Defines policies applying to an RPC method. "requestPolicies": [ # Policies that are applicable to the request message. diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.html b/docs/dyn/storagebatchoperations_v1.projects.locations.html index 1b2ce155c0..39c7c40164 100644 --- a/docs/dyn/storagebatchoperations_v1.projects.locations.html +++ b/docs/dyn/storagebatchoperations_v1.projects.locations.html @@ -135,7 +135,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/travelimpactmodel_v1.flights.html b/docs/dyn/travelimpactmodel_v1.flights.html index abb2ba291a..d2fcdd22b5 100644 --- a/docs/dyn/travelimpactmodel_v1.flights.html +++ b/docs/dyn/travelimpactmodel_v1.flights.html @@ -183,16 +183,16 @@

Method Details

"flights": [ # Required. Flights to return emission estimates for. { # Flight parameters with which the Scope 3 emissions are fetched. "cabinClass": "A String", # Required. The cabin class of the flight. - "carrierCode": "A String", # Optional. IATA carrier code, e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered). + "carrierCode": "A String", # Optional. 2-character [IATA carrier code](https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered). "departureDate": { # 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 # Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "destination": "A String", # Optional. IATA airport code for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. - "distanceKm": "A String", # Optional. Distance in kilometers, e.g. `2423`. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km. - "flightNumber": 42, # Optional. Flight number, e.g. `71`. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided. - "origin": "A String", # Optional. IATA airport code for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. + "destination": "A String", # Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. + "distanceKm": "A String", # Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) km. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. + "flightNumber": 42, # Optional. Up to 4-digit [flight number](https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided. + "origin": "A String", # Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. }, ], "modelVersion": { # Travel Impact Model version. For more information about the model versioning see [GitHub](https://github.com/google/travel-impact-model/#versioning). # Optional. The model version under which emission estimates for all flights in this request were computed. @@ -216,16 +216,16 @@

Method Details

{ # Scope 3 flight with emission estimates. "flight": { # Flight parameters with which the Scope 3 emissions are fetched. # Required. Matches the flight identifiers in the request. "cabinClass": "A String", # Required. The cabin class of the flight. - "carrierCode": "A String", # Optional. IATA carrier code, e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered). + "carrierCode": "A String", # Optional. 2-character [IATA carrier code](https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered). "departureDate": { # 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 # Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, - "destination": "A String", # Optional. IATA airport code for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. - "distanceKm": "A String", # Optional. Distance in kilometers, e.g. `2423`. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km. - "flightNumber": 42, # Optional. Flight number, e.g. `71`. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided. - "origin": "A String", # Optional. IATA airport code for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. + "destination": "A String", # Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. + "distanceKm": "A String", # Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) km. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. + "flightNumber": 42, # Optional. Up to 4-digit [flight number](https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided. + "origin": "A String", # Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided. }, "source": "A String", # Optional. The source of the emissions data. "ttwEmissionsGramsPerPax": "A String", # Optional. Tank-to-wake flight emissions per passenger based on the requested info. diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html index 2a7da0a854..44ab70bd0c 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.results.html @@ -135,7 +135,7 @@

Method Details

"type": "A String", # Execution result type of the scanned resource "violationDetails": { # Message describing the violation in an evaluation result. # The details of violation in an evaluation result. "asset": "A String", # The name of the asset. - "observed": { # Details of the violation. + "observed": { # Details of the violation. TODO(b/452163887) "a_key": "A String", }, "serviceAccount": "A String", # The service account associated with the resource. diff --git a/docs/dyn/workloadmanager_v1.projects.locations.html b/docs/dyn/workloadmanager_v1.projects.locations.html index 8647dcd8ab..89085ed61d 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.html @@ -150,7 +150,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) + extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 94d0d29748..3f22165459 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20251015", +"revision": "20251022", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2747,7 +2747,7 @@ false ], "enumDescriptions": [ "This value is disallowed.", -"Lock the device, as if the lock screen timeout had expired.", +"Lock the device, as if the lock screen timeout had expired. For a work profile, if there is a separate work profile lock, this only locks the work profile, with one exception: on work profiles on an organization-owned device running Android 8, 9, or 10, this locks the entire device.", "Reset the user's password.", "Reboot the device. Only supported on fully managed devices running Android 7.0 (API level 24) or higher.", "Removes the work profile and all policies from a company-owned Android 8.0+ device, relinquishing the device for personal use. Apps and data associated with the personal profile(s) are preserved. The device will be deleted from the server after it acknowledges the command.", diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index b0043bb29a..0065e6fe45 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -143,7 +143,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1094,7 +1094,7 @@ } } }, -"revision": "20251001", +"revision": "20251021", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json index 45ac73da0b..8e1f3a713e 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -143,7 +143,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1094,7 +1094,7 @@ } } }, -"revision": "20251001", +"revision": "20251021", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index 5868530bf7..5df178ed4a 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -851,7 +851,7 @@ } } }, -"revision": "20250924", +"revision": "20251022", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { diff --git a/googleapiclient/discovery_cache/documents/batch.v1.json b/googleapiclient/discovery_cache/documents/batch.v1.json index df091cf19e..98d2075579 100644 --- a/googleapiclient/discovery_cache/documents/batch.v1.json +++ b/googleapiclient/discovery_cache/documents/batch.v1.json @@ -600,7 +600,7 @@ } } }, -"revision": "20251005", +"revision": "20251020", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1304,13 +1304,15 @@ "STANDARD", "SPOT", "PREEMPTIBLE", -"RESERVATION_BOUND" +"RESERVATION_BOUND", +"FLEX_START" ], "enumDeprecated": [ false, false, false, true, +false, false ], "enumDescriptions": [ @@ -1318,7 +1320,8 @@ false "Standard VM.", "SPOT VM.", "Preemptible VM (PVM). Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported.", -"Bound to the lifecycle of the reservation in which it is provisioned." +"Bound to the lifecycle of the reservation in which it is provisioned.", +"Instance is provisioned with DWS Flex Start and has limited max run duration." ], "type": "string" }, @@ -1375,13 +1378,15 @@ false "STANDARD", "SPOT", "PREEMPTIBLE", -"RESERVATION_BOUND" +"RESERVATION_BOUND", +"FLEX_START" ], "enumDeprecated": [ false, false, false, true, +false, false ], "enumDescriptions": [ @@ -1389,7 +1394,8 @@ false "Standard VM.", "SPOT VM.", "Preemptible VM (PVM). Above SPOT VM is the preferable model for preemptible VM instances: the old preemptible VM model (indicated by this field) is the older model, and has been migrated to use the SPOT model as the underlying technology. This old model will still be supported.", -"Bound to the lifecycle of the reservation in which it is provisioned." +"Bound to the lifecycle of the reservation in which it is provisioned.", +"Instance is provisioned with DWS Flex Start and has limited max run duration." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index de0f15c1b2..ef2376d6b8 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -3070,7 +3070,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3118,7 +3118,7 @@ } } }, -"revision": "20251012", +"revision": "20251026", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3627,7 +3627,7 @@ }, "valueType": { "$ref": "Type", -"description": "The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations" +"description": "The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. This field is mutually exclusive with `sql_type`. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index 4f19986234..a2a1fffa5b 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -123,6 +123,20 @@ "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +false +], "enumDescriptions": [ "Represents the default unknown value.", "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", @@ -215,6 +229,20 @@ "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +false +], "enumDescriptions": [ "Represents the default unknown value.", "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", @@ -417,7 +445,7 @@ } } }, -"revision": "20241002", +"revision": "20251026", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { @@ -440,6 +468,20 @@ "BUSINESS_FOOD_ORDERS", "BUSINESS_FOOD_MENU_CLICKS" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +false +], "enumDescriptions": [ "Represents the default unknown value.", "Business impressions on Google Maps on Desktop devices. Multiple impressions by a unique user within a single day are counted as a single impression.", diff --git a/googleapiclient/discovery_cache/documents/chromewebstore.v2.json b/googleapiclient/discovery_cache/documents/chromewebstore.v2.json new file mode 100644 index 0000000000..4f6a04793c --- /dev/null +++ b/googleapiclient/discovery_cache/documents/chromewebstore.v2.json @@ -0,0 +1,550 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/chromewebstore": { +"description": "See, edit, update, or publish your Chrome Web Store extensions, themes, apps, and licences you have access to" +}, +"https://www.googleapis.com/auth/chromewebstore.readonly": { +"description": "See and download your Chrome Web Store extensions and apps, and see licenses you have access to" +} +} +} +}, +"basePath": "", +"baseUrl": "https://chromewebstore.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Chromewebstore", +"description": "The Chrome Web Store API provides access to data about apps and extensions, as well as developer tools for managing them.", +"discoveryVersion": "v1", +"documentationLink": "https://developer.chrome.com/docs/webstore/api", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "chromewebstore:v2", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://chromewebstore.mtls.googleapis.com/", +"name": "chromewebstore", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"media": { +"methods": { +"upload": { +"description": "Upload a new package to an existing item.", +"flatPath": "v2/publishers/{publishersId}/items/{itemsId}:upload", +"httpMethod": "POST", +"id": "chromewebstore.media.upload", +"mediaUpload": { +"accept": [ +"*/*" +], +"maxSize": "2147483648", +"protocols": { +"simple": { +"multipart": true, +"path": "/upload/v2/{+name}:upload" +} +} +}, +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the item to upload the new package to in the form `publishers/{publisherId}/items/{itemId}`", +"location": "path", +"pattern": "^publishers/[^/]+/items/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:upload", +"request": { +"$ref": "UploadItemPackageRequest" +}, +"response": { +"$ref": "UploadItemPackageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chromewebstore" +], +"supportsMediaUpload": true +} +} +}, +"publishers": { +"resources": { +"items": { +"methods": { +"cancelSubmission": { +"description": "Cancel the current active submission of an item if present. This can be used to cancel the review of a pending submission.", +"flatPath": "v2/publishers/{publishersId}/items/{itemsId}:cancelSubmission", +"httpMethod": "POST", +"id": "chromewebstore.publishers.items.cancelSubmission", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the item to cancel the submission of in the form `publishers/{publisherId}/items/{itemId}`", +"location": "path", +"pattern": "^publishers/[^/]+/items/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:cancelSubmission", +"request": { +"$ref": "CancelSubmissionRequest" +}, +"response": { +"$ref": "CancelSubmissionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chromewebstore" +] +}, +"fetchStatus": { +"description": "Fetch the status of an item.", +"flatPath": "v2/publishers/{publishersId}/items/{itemsId}:fetchStatus", +"httpMethod": "GET", +"id": "chromewebstore.publishers.items.fetchStatus", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the item to retrieve the status of in the form `publishers/{publisherId}/items/{itemId}`", +"location": "path", +"pattern": "^publishers/[^/]+/items/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:fetchStatus", +"response": { +"$ref": "FetchItemStatusResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chromewebstore", +"https://www.googleapis.com/auth/chromewebstore.readonly" +] +}, +"publish": { +"description": "Submit the item to be published in the store. The item will be submitted for review unless `skip_review` is set to true, or the item is staged from a previous submission with `publish_type` set to `STAGED_PUBLISH`.", +"flatPath": "v2/publishers/{publishersId}/items/{itemsId}:publish", +"httpMethod": "POST", +"id": "chromewebstore.publishers.items.publish", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the item in the form `publishers/{publisherId}/items/{itemId}`", +"location": "path", +"pattern": "^publishers/[^/]+/items/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:publish", +"request": { +"$ref": "PublishItemRequest" +}, +"response": { +"$ref": "PublishItemResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chromewebstore" +] +}, +"setPublishedDeployPercentage": { +"description": "Set a higher target deploy percentage for the item's published revision. This will be updated without the item being submitted for review. This is only available to items with over 10,000 seven-day active users.", +"flatPath": "v2/publishers/{publishersId}/items/{itemsId}:setPublishedDeployPercentage", +"httpMethod": "POST", +"id": "chromewebstore.publishers.items.setPublishedDeployPercentage", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the item to update the published revision of in the form `publishers/{publisherId}/items/{itemId}`", +"location": "path", +"pattern": "^publishers/[^/]+/items/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:setPublishedDeployPercentage", +"request": { +"$ref": "SetPublishedDeployPercentageRequest" +}, +"response": { +"$ref": "SetPublishedDeployPercentageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/chromewebstore" +] +} +} +} +} +} +}, +"revision": "20251026", +"rootUrl": "https://chromewebstore.googleapis.com/", +"schemas": { +"CancelSubmissionRequest": { +"description": "Request message for CancelSubmission.", +"id": "CancelSubmissionRequest", +"properties": {}, +"type": "object" +}, +"CancelSubmissionResponse": { +"description": "Response message for `CancelSubmission`.", +"id": "CancelSubmissionResponse", +"properties": {}, +"type": "object" +}, +"DeployInfo": { +"description": "Deployment information for a specific release channel. Used in requests to update deployment parameters.", +"id": "DeployInfo", +"properties": { +"deployPercentage": { +"description": "Required. The current deploy percentage for the release channel (nonnegative number between 0 and 100).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DistributionChannel": { +"description": "Deployment information for a specific release channel", +"id": "DistributionChannel", +"properties": { +"crxVersion": { +"description": "The extension version provided in the manifest of the uploaded package.", +"type": "string" +}, +"deployPercentage": { +"description": "The current deploy percentage for the release channel (nonnegative number between 0 and 100).", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"FetchItemStatusResponse": { +"description": "Response message for `FetchItemStatus`.", +"id": "FetchItemStatusResponse", +"properties": { +"itemId": { +"description": "Output only. The ID of the item.", +"readOnly": true, +"type": "string" +}, +"lastAsyncUploadState": { +"description": "Output only. The state of the last async upload for an item. Only set when there has been an async upload for the item in the past 24 hours.", +"enum": [ +"UPLOAD_STATE_UNSPECIFIED", +"SUCCEEDED", +"IN_PROGRESS", +"FAILED", +"NOT_FOUND" +], +"enumDescriptions": [ +"The default value.", +"The upload succeeded.", +"The upload is currently being processed.", +"The upload failed.", +"Used as the value of `lastAsyncUploadState` in a `fetchStatus` response indicating that an upload attempt was not found." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "The name of the requested item.", +"type": "string" +}, +"publicKey": { +"description": "The public key of the item, which may be generated by the store.", +"type": "string" +}, +"publishedItemRevisionStatus": { +"$ref": "ItemRevisionStatus", +"description": "Output only. Status of the current published revision of the item. Will be unset if the item is not published.", +"readOnly": true +}, +"submittedItemRevisionStatus": { +"$ref": "ItemRevisionStatus", +"description": "Status of the item revision submitted to be published. Will be unset if the item has not been submitted for publishing since the last successful publish." +}, +"takenDown": { +"description": "If true, the item has been taken down for a policy violation. Check the developer dashboard for details.", +"type": "boolean" +}, +"warned": { +"description": "If true, the item has been warned for a policy violation and will be taken down if not resolved. Check the developer dashboard for details.", +"type": "boolean" +} +}, +"type": "object" +}, +"ItemRevisionStatus": { +"description": "Details on the status of an item revision.", +"id": "ItemRevisionStatus", +"properties": { +"distributionChannels": { +"description": "Details on the package of the item", +"items": { +"$ref": "DistributionChannel" +}, +"type": "array" +}, +"state": { +"description": "Output only. Current state of the item", +"enum": [ +"ITEM_STATE_UNSPECIFIED", +"PENDING_REVIEW", +"STAGED", +"PUBLISHED", +"PUBLISHED_TO_TESTERS", +"REJECTED", +"CANCELLED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The item is pending review.", +"The item has been approved and is ready to be published.", +"The item is published publicly.", +"The item is published to trusted testers.", +"The item has been rejected for publishing.", +"The item submission has been cancelled." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PublishItemRequest": { +"description": "Request message for PublishItem.", +"id": "PublishItemRequest", +"properties": { +"deployInfos": { +"description": "Optional. Additional deploy information including the desired initial percentage rollout. Defaults to the current value saved in the developer dashboard if unset.", +"items": { +"$ref": "DeployInfo" +}, +"type": "array" +}, +"publishType": { +"description": "Optional. Use this to control if the item is published immediately on approval or staged for publishing in the future. Defaults to `DEFAULT_PUBLISH` if unset.", +"enum": [ +"PUBLISH_TYPE_UNSPECIFIED", +"DEFAULT_PUBLISH", +"STAGED_PUBLISH" +], +"enumDescriptions": [ +"Default value. This is the same as DEFAULT_PUBLISH.", +"The submission will be published immediately after being approved.", +"After approval the submission will be staged and can then be published by the developer." +], +"type": "string" +}, +"skipReview": { +"description": "Optional. Whether to attempt to skip item review. The API will validate if the item qualifies and return a validation error if the item requires review. Defaults to `false` if unset.", +"type": "boolean" +} +}, +"type": "object" +}, +"PublishItemResponse": { +"description": "Response message for `PublishItem`.", +"id": "PublishItemResponse", +"properties": { +"itemId": { +"description": "Output only. The ID of the item.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "The name of the item that was submitted", +"type": "string" +}, +"state": { +"description": "Output only. The current state of the submission.", +"enum": [ +"ITEM_STATE_UNSPECIFIED", +"PENDING_REVIEW", +"STAGED", +"PUBLISHED", +"PUBLISHED_TO_TESTERS", +"REJECTED", +"CANCELLED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The item is pending review.", +"The item has been approved and is ready to be published.", +"The item is published publicly.", +"The item is published to trusted testers.", +"The item has been rejected for publishing.", +"The item submission has been cancelled." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SetPublishedDeployPercentageRequest": { +"description": "Request message for SetPublishedDeployPercentage.", +"id": "SetPublishedDeployPercentageRequest", +"properties": { +"deployPercentage": { +"description": "Required. Unscaled percentage value for the publised revision (nonnegative number between 0 and 100). It must be larger than the existing target percentage.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"SetPublishedDeployPercentageResponse": { +"description": "Response message for `SetPublishedDeployPercentage`.", +"id": "SetPublishedDeployPercentageResponse", +"properties": {}, +"type": "object" +}, +"UploadItemPackageRequest": { +"description": "Request message for UploadItemPackage.", +"id": "UploadItemPackageRequest", +"properties": {}, +"type": "object" +}, +"UploadItemPackageResponse": { +"description": "Response message for `UploadItemPackage`.", +"id": "UploadItemPackageResponse", +"properties": { +"crxVersion": { +"description": "The extension version provided in the manifest of the uploaded package. This will not be set if the upload is still in progress (`upload_state` is `UPLOAD_IN_PROGRESS`).", +"type": "string" +}, +"itemId": { +"description": "Output only. The ID of the item the package was uploaded to.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "The name of the item the package was uploaded to.", +"type": "string" +}, +"uploadState": { +"description": "Output only. The state of the upload. If `upload_state` is `UPLOAD_IN_PROGRESS`, you can poll for updates using the fetchStatus method.", +"enum": [ +"UPLOAD_STATE_UNSPECIFIED", +"SUCCEEDED", +"IN_PROGRESS", +"FAILED", +"NOT_FOUND" +], +"enumDescriptions": [ +"The default value.", +"The upload succeeded.", +"The upload is currently being processed.", +"The upload failed.", +"Used as the value of `lastAsyncUploadState` in a `fetchStatus` response indicating that an upload attempt was not found." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Chrome Web Store API", +"version": "v2", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index 45ac5d659d..a2f9f8fd1c 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -371,7 +371,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1087,7 +1087,7 @@ } } }, -"revision": "20250903", +"revision": "20251021", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index fca08e5b17..ed17cf7f2a 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2359,7 +2359,7 @@ } } }, -"revision": "20251001", +"revision": "20251022", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json index c5b4e83361..43378ec691 100644 --- a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -304,7 +304,7 @@ } } }, -"revision": "20250905", +"revision": "20251022", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json index b5b9abdafa..fbf0f23516 100644 --- a/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudlocationfinder.v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -304,7 +304,7 @@ } } }, -"revision": "20250905", +"revision": "20251022", "rootUrl": "https://cloudlocationfinder.googleapis.com/", "schemas": { "CloudLocation": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json index 46a9a96d84..5005dd28e6 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -785,7 +785,7 @@ } } }, -"revision": "20250914", +"revision": "20251021", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json index 8b7c6bd28d..55330c06a3 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta2.json @@ -201,7 +201,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -941,7 +941,7 @@ } } }, -"revision": "20250914", +"revision": "20251021", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AcknowledgeTaskRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json index 568c45bba4..e462b1696e 100644 --- a/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json +++ b/googleapiclient/discovery_cache/documents/cloudtasks.v2beta3.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -797,7 +797,7 @@ } } }, -"revision": "20250914", +"revision": "20251021", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index 55ea5623c9..9f1106173b 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -523,7 +523,7 @@ } } }, -"revision": "20250925", +"revision": "20251022", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 2f52cc0095..8f7d3cc0e2 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1676,7 +1676,7 @@ } } }, -"revision": "20250828", +"revision": "20251024", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2704,11 +2704,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2750,6 +2751,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2788,6 +2790,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -3092,11 +3095,12 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3138,6 +3142,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3176,6 +3181,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -3404,11 +3410,12 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3450,6 +3457,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3488,6 +3496,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index 436e68b6c3..dd612a5347 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -1028,7 +1028,7 @@ } } }, -"revision": "20250828", +"revision": "20251024", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1754,11 +1754,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -1800,6 +1801,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -1838,6 +1840,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -2061,11 +2064,12 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2107,6 +2111,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2145,6 +2150,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -2350,11 +2356,12 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2396,6 +2403,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2434,6 +2442,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index b8e5bf24f8..b01f5c1d62 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1636,7 +1636,7 @@ } } }, -"revision": "20250828", +"revision": "20251024", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -2603,11 +2603,12 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -2649,6 +2650,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -2687,6 +2689,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -2968,11 +2971,12 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3014,6 +3018,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3052,6 +3057,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", @@ -3257,11 +3263,12 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", -"RESERVED_ENTRY_135", +"UPCOMING_MAINTENANCES_UNAVAILABLE", "RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", -"RESERVED_ENTRY_142" +"RESERVED_ENTRY_142", +"RESERVED_ENTRY_143" ], "enumDeprecated": [ false, @@ -3303,6 +3310,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -3341,6 +3349,7 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index b6f4419cb8..0023fe7045 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -221,7 +221,7 @@ } } }, -"revision": "20251013", +"revision": "20251022", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -952,11 +952,11 @@ "description": "The background of the document. Documents cannot have a transparent background color." }, "defaultFooterId": { -"description": "The ID of the default footer. If not set, there's no default footer. This property is read-only.", +"description": "The ID of the default footer. If not set, there's no default footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "defaultHeaderId": { -"description": "The ID of the default header. If not set, there's no default header. This property is read-only.", +"description": "The ID of the default header. If not set, there's no default header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "documentFormat": { @@ -964,68 +964,68 @@ "description": "Specifies document-level format settings, such as the document mode (pages vs pageless)." }, "evenPageFooterId": { -"description": "The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.", +"description": "The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "evenPageHeaderId": { -"description": "The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.", +"description": "The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageFooterId": { -"description": "The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.", +"description": "The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageHeaderId": { -"description": "The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.", +"description": "The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "flipPageOrientation": { -"description": "Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.", +"description": "Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. If DocumentMode is PAGELESS, this property will not be rendered.", "type": "boolean" }, "marginBottom": { "$ref": "Dimension", -"description": "The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles." +"description": "The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginFooter": { "$ref": "Dimension", -"description": "The amount of space between the bottom of the page and the contents of the footer." +"description": "The amount of space between the bottom of the page and the contents of the footer. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginHeader": { "$ref": "Dimension", -"description": "The amount of space between the top of the page and the contents of the header." +"description": "The amount of space between the top of the page and the contents of the header. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginLeft": { "$ref": "Dimension", -"description": "The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections." +"description": "The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginRight": { "$ref": "Dimension", -"description": "The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections." +"description": "The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. If DocumentMode is PAGELESS, this property will not be rendered." }, "marginTop": { "$ref": "Dimension", -"description": "The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles." +"description": "The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. If DocumentMode is PAGELESS, this property will not be rendered." }, "pageNumberStart": { -"description": "The page number from which to start counting the number of pages.", +"description": "The page number from which to start counting the number of pages. If DocumentMode is PAGELESS, this property will not be rendered.", "format": "int32", "type": "integer" }, "pageSize": { "$ref": "Size", -"description": "The size of a page in the document." +"description": "The size of a page in the document. If DocumentMode is PAGELESS, this property will not be rendered." }, "useCustomHeaderFooterMargins": { -"description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. This property is read-only.", +"description": "Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin is used. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "boolean" }, "useEvenPageHeaderFooter": { -"description": "Indicates whether to use the even page header / footer IDs for the even pages.", +"description": "Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered.", "type": "boolean" }, "useFirstPageHeaderFooter": { -"description": "Indicates whether to use the first page header / footer IDs for the first page.", +"description": "Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered.", "type": "boolean" } }, @@ -1784,11 +1784,11 @@ "properties": { "endOfSegmentLocation": { "$ref": "EndOfSegmentLocation", -"description": "Inserts the person at the end of a header, footer, footnote or the document body." +"description": "Inserts the person mention at the end of a header, footer, footnote or the document body." }, "location": { "$ref": "Location", -"description": "Inserts the person at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation." +"description": "Inserts the person mention at a specific index in the document. The person mention must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). People cannot be inserted inside an equation." }, "personProperties": { "$ref": "PersonProperties", @@ -3399,59 +3399,59 @@ "type": "string" }, "defaultFooterId": { -"description": "The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.", +"description": "The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "defaultHeaderId": { -"description": "The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.", +"description": "The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "evenPageFooterId": { -"description": "The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.", +"description": "The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "evenPageHeaderId": { -"description": "The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.", +"description": "The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageFooterId": { -"description": "The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.", +"description": "The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "firstPageHeaderId": { -"description": "The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.", +"description": "The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. If DocumentMode is PAGELESS, this property will not be rendered. This property is read-only.", "type": "string" }, "flipPageOrientation": { -"description": "Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", +"description": "Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", "type": "boolean" }, "marginBottom": { "$ref": "Dimension", -"description": "The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." +"description": "The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginFooter": { "$ref": "Dimension", -"description": "The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." +"description": "The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginHeader": { "$ref": "Dimension", -"description": "The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." +"description": "The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginLeft": { "$ref": "Dimension", -"description": "The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." +"description": "The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginRight": { "$ref": "Dimension", -"description": "The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." +"description": "The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "marginTop": { "$ref": "Dimension", -"description": "The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." +"description": "The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." }, "pageNumberStart": { -"description": "The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", +"description": "The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", "format": "int32", "type": "integer" }, @@ -3470,7 +3470,7 @@ "type": "string" }, "useFirstPageHeaderFooter": { -"description": "Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", +"description": "Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. If DocumentMode is PAGELESS, this property will not be rendered. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json index 409dbfd3c3..96cf862d2e 100644 --- a/googleapiclient/discovery_cache/documents/eventarc.v1.json +++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json @@ -169,7 +169,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2471,7 +2471,7 @@ } } }, -"revision": "20251007", +"revision": "20251024", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 9739dfc60f..e37ccb0f5c 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20251013", +"revision": "20251022", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -398,16 +398,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { -"description": "Content blob.", +"description": "A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video.", "id": "GoogleCloudAiplatformV1beta1Blob", "properties": { "data": { -"description": "Required. Raw bytes.", +"description": "Required. The raw bytes of the data.", "format": "byte", "type": "string" }, "displayName": { -"description": "Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", +"description": "Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "mimeType": { @@ -422,28 +422,28 @@ "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { "avgLogprobs": { -"description": "Output only. Average log probability score of the candidate.", +"description": "Output only. The average log probability of the tokens in this candidate. This is a length-normalized score that can be used to compare the quality of candidates of different lengths. A higher average log probability suggests a more confident and coherent response.", "format": "double", "readOnly": true, "type": "number" }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", -"description": "Output only. Source attribution of the generated content.", +"description": "Output only. A collection of citations that apply to the generated content.", "readOnly": true }, "content": { "$ref": "GoogleCloudAiplatformV1beta1Content", -"description": "Output only. Content parts of the candidate.", +"description": "Output only. The content of the candidate.", "readOnly": true }, "finishMessage": { -"description": "Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set.", +"description": "Output only. Describes the reason the model stopped generating tokens in more detail. This field is returned only when `finish_reason` is set.", "readOnly": true, "type": "string" }, "finishReason": { -"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.", +"description": "Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating.", "enum": [ "FINISH_REASON_UNSPECIFIED", "STOP", @@ -465,44 +465,44 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", -"Token generation reached a natural stopping point or a configured stop sequence.", -"Token generation reached the configured maximum output tokens.", -"Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", -"The token generation stopped because of potential recitation.", -"All other reasons that stopped the token generation.", -"Token generation stopped because the content contains forbidden terms.", -"Token generation stopped for potentially containing prohibited content.", -"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", -"The function call generated by the model is syntaxtically invalid (e.g. the function call generated is not parsable).", +"The model reached a natural stopping point or a configured stop sequence.", +"The model generated the maximum number of tokens allowed by the `max_output_tokens` parameter.", +"The model stopped generating because the content potentially violates safety policies. NOTE: When streaming, the `content` field is empty if content filters block the output.", +"The model stopped generating because the content may be a recitation from a source.", +"The model stopped generating for a reason not otherwise specified.", +"The model stopped generating because the content contains a term from a configured blocklist.", +"The model stopped generating because the content may be prohibited.", +"The model stopped generating because the content may contain sensitive personally identifiable information (SPII).", +"The model generated a function call that is syntactically invalid and can't be parsed.", "The model response was blocked by Model Armor.", -"Token generation stopped because generated images has safety violations.", -"Image generation stopped because generated images has other prohibited content.", -"Image generation stopped due to recitation.", -"Image generation stopped because of other miscellaneous issue.", -"The function call generated by the model is semantically invalid (e.g. a function call is generated when function calling is not enabled or the function is not in the function declaration).", -"The model was expected to generate an image, but none was generated." +"The generated image potentially violates safety policies.", +"The generated image may contain prohibited content.", +"The generated image may be a recitation from a source.", +"The image generation stopped for a reason not otherwise specified.", +"The model generated a function call that is semantically invalid. This can happen, for example, if function calling is not enabled or the generated function is not in the function declaration.", +"The model was expected to generate an image, but didn't." ], "readOnly": true, "type": "string" }, "groundingMetadata": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadata", -"description": "Output only. Metadata specifies sources used to ground generated content.", +"description": "Output only. Metadata returned when grounding is enabled. It contains the sources used to ground the generated content.", "readOnly": true }, "index": { -"description": "Output only. Index of the candidate.", +"description": "Output only. The 0-based index of this candidate in the list of generated responses. This is useful for distinguishing between multiple candidates when `candidate_count` > 1.", "format": "int32", "readOnly": true, "type": "integer" }, "logprobsResult": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult", -"description": "Output only. Log-likelihood scores for the response tokens and top tokens", +"description": "Output only. The detailed log probability information for the tokens in this candidate. This is useful for debugging, understanding model uncertainty, and identifying potential \"hallucinations\".", "readOnly": true }, "safetyRatings": { -"description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", +"description": "Output only. A list of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -511,45 +511,45 @@ }, "urlContextMetadata": { "$ref": "GoogleCloudAiplatformV1beta1UrlContextMetadata", -"description": "Output only. Metadata related to url context retrieval tool.", +"description": "Output only. Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "readOnly": true } }, "type": "object" }, "GoogleCloudAiplatformV1beta1Citation": { -"description": "Source attributions for content.", +"description": "A citation for a piece of generatedcontent.", "id": "GoogleCloudAiplatformV1beta1Citation", "properties": { "endIndex": { -"description": "Output only. End index into the content.", +"description": "Output only. The end index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "license": { -"description": "Output only. License of the attribution.", +"description": "Output only. The license of the source of the citation.", "readOnly": true, "type": "string" }, "publicationDate": { "$ref": "Date", -"description": "Output only. Publication date of the attribution.", +"description": "Output only. The publication date of the source of the citation.", "readOnly": true }, "startIndex": { -"description": "Output only. Start index into the content.", +"description": "Output only. The start index of the citation in the content.", "format": "int32", "readOnly": true, "type": "integer" }, "title": { -"description": "Output only. Title of the attribution.", +"description": "Output only. The title of the source of the citation.", "readOnly": true, "type": "string" }, "uri": { -"description": "Output only. Url reference of the attribution.", +"description": "Output only. The URI of the source of the citation.", "readOnly": true, "type": "string" } @@ -557,11 +557,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1CitationMetadata": { -"description": "A collection of source attributions for a piece of content.", +"description": "A collection of citations that apply to a piece of generated content.", "id": "GoogleCloudAiplatformV1beta1CitationMetadata", "properties": { "citations": { -"description": "Output only. List of citations.", +"description": "Output only. A list of citations for the content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Citation" }, @@ -599,18 +599,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Content": { -"description": "The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.", +"description": "The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message.", "id": "GoogleCloudAiplatformV1beta1Content", "properties": { "parts": { -"description": "Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.", +"description": "Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Part" }, "type": "array" }, "role": { -"description": "Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset.", +"description": "Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.", "type": "string" } }, @@ -833,15 +833,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1FileData": { -"description": "URI based data.", +"description": "URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage.", "id": "GoogleCloudAiplatformV1beta1FileData", "properties": { "displayName": { -"description": "Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.", +"description": "Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.", "type": "string" }, "fileUri": { -"description": "Required. URI.", +"description": "Required. The URI of the file in Google Cloud Storage.", "type": "string" }, "mimeType": { @@ -1249,24 +1249,24 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfig": { -"description": "Generation config.", +"description": "Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig", "properties": { "audioTimestamp": { -"description": "Optional. If enabled, audio timestamp will be included in the request to the model.", +"description": "Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.", "type": "boolean" }, "candidateCount": { -"description": "Optional. Number of candidates to generate.", +"description": "Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.", "format": "int32", "type": "integer" }, "enableAffectiveDialog": { -"description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly.", +"description": "Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.", "type": "boolean" }, "frequencyPenalty": { -"description": "Optional. Frequency penalties.", +"description": "Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, @@ -1275,17 +1275,17 @@ "description": "Optional. Config for image generation features." }, "logprobs": { -"description": "Optional. Logit probabilities.", +"description": "Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.", "format": "int32", "type": "integer" }, "maxOutputTokens": { -"description": "Optional. The maximum number of output tokens to generate per message.", +"description": "Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.", "format": "int32", "type": "integer" }, "mediaResolution": { -"description": "Optional. If specified, the media resolution specified will be used.", +"description": "Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.", "enum": [ "MEDIA_RESOLUTION_UNSPECIFIED", "MEDIA_RESOLUTION_LOW", @@ -1306,24 +1306,24 @@ "description": "Optional. Config for model selection." }, "presencePenalty": { -"description": "Optional. Positive penalties.", +"description": "Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].", "format": "float", "type": "number" }, "responseJsonSchema": { -"description": "Optional. Output schema of the generated response. This is an alternative to `response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, `response_schema` must be omitted, but `response_mime_type` is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor` - `type` - `format` - `title` - `description` - `enum` (for strings and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - `additionalProperties` - `required` The non-standard `propertyOrdering` property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If `$ref` is set on a sub-schema, no other properties, except for than those starting as a `$`, may be set.", +"description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", "type": "any" }, "responseLogprobs": { -"description": "Optional. If true, export the logprobs results in response.", +"description": "Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.", "type": "boolean" }, "responseMimeType": { -"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", +"description": "Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" }, "responseModalities": { -"description": "Optional. The modalities of the response.", +"description": "Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.", "items": { "enum": [ "MODALITY_UNSPECIFIED", @@ -1343,14 +1343,14 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1beta1Schema", -"description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." +"description": "Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "description": "Optional. Routing configuration." }, "seed": { -"description": "Optional. Seed.", +"description": "Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the \"random\" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.", "format": "int32", "type": "integer" }, @@ -1359,28 +1359,28 @@ "description": "Optional. The speech generation config." }, "stopSequences": { -"description": "Optional. Stop sequences.", +"description": "Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use [\"\\n\", \"###\"] to stop generation at a new line or a specific marker.", "items": { "type": "string" }, "type": "array" }, "temperature": { -"description": "Optional. Controls the randomness of predictions.", +"description": "Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].", "format": "float", "type": "number" }, "thinkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", -"description": "Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking." +"description": "Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking." }, "topK": { -"description": "Optional. If specified, top-k sampling will be used.", +"description": "Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.", "format": "float", "type": "number" }, "topP": { -"description": "Optional. If specified, nucleus sampling will be used.", +"description": "Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.", "format": "float", "type": "number" } @@ -1411,22 +1411,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { -"description": "The configuration for routing the request to a specific model.", +"description": "The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "properties": { "autoMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", -"description": "Automated routing." +"description": "In this mode, the model is selected automatically based on the content of the request." }, "manualMode": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", -"description": "Manual routing." +"description": "In this mode, the model is specified manually." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { -"description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", +"description": "The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { "modelRoutingPreference": { @@ -1439,9 +1439,9 @@ ], "enumDescriptions": [ "Unspecified model routing preference.", -"Prefer higher quality over low cost.", -"Balanced model routing preference.", -"Prefer lower cost over higher quality." +"The model will be selected to prioritize the quality of the response.", +"The model will be selected to balance quality and cost.", +"The model will be selected to prioritize the cost of the request." ], "type": "string" } @@ -1449,26 +1449,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { -"description": "When manual routing is set, the specified model will be used directly.", +"description": "The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "properties": { "modelName": { -"description": "The model name to use. Only the public LLM models are accepted. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).", +"description": "The name of the model to use. Only public LLM models are accepted.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig": { -"description": "Config for thinking features.", +"description": "Configuration for the model's thinking features. \"Thinking\" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response.", "id": "GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig", "properties": { "includeThoughts": { -"description": "Optional. Indicates whether to include thoughts in the response. If true, thoughts are returned only when available.", +"description": "Optional. If true, the model will include its thoughts in the response. \"Thoughts\" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.", "type": "boolean" }, "thinkingBudget": { -"description": "Optional. Indicates the thinking budget in tokens.", +"description": "Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.", "format": "int32", "type": "integer" } @@ -1498,57 +1498,57 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunk": { -"description": "Grounding chunk.", +"description": "A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", "properties": { "maps": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", -"description": "Grounding chunk from Google Maps." +"description": "A grounding chunk from Google Maps. See the `Maps` message for details." }, "retrievedContext": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", -"description": "Grounding chunk from context retrieved by the retrieval tools." +"description": "A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the `RetrievedContext` message for details" }, "web": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", -"description": "Grounding chunk from the web." +"description": "A grounding chunk from a web page, typically from Google Search. See the `Web` message for details." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMaps": { -"description": "Chunk from Google Maps.", +"description": "A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMaps", "properties": { "placeAnswerSources": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", -"description": "Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content." +"description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content." }, "placeId": { -"description": "This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place.", +"description": "This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.", "type": "string" }, "text": { -"description": "Text of the place answer.", +"description": "The text of the place answer.", "type": "string" }, "title": { -"description": "Title of the place.", +"description": "The title of the place.", "type": "string" }, "uri": { -"description": "URI reference of the place.", +"description": "The URI of the place.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources": { -"description": "Sources used to generate the place answer.", +"description": "The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { "reviewSnippets": { -"description": "Snippets of reviews that are used to generate the answer.", +"description": "Snippets of reviews that were used to generate the answer.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet" }, @@ -1558,7 +1558,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { -"description": "Encapsulates a review snippet.", +"description": "A review snippet that is used to generate the answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { "googleMapsUri": { @@ -1566,81 +1566,81 @@ "type": "string" }, "reviewId": { -"description": "Id of the review referencing the place.", +"description": "The ID of the review that is being referenced.", "type": "string" }, "title": { -"description": "Title of the review.", +"description": "The title of the review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { -"description": "Chunk from context retrieved by the retrieval tools.", +"description": "Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", "properties": { "documentName": { -"description": "Output only. The full document name for the referenced Vertex AI Search document.", +"description": "Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.", "readOnly": true, "type": "string" }, "ragChunk": { "$ref": "GoogleCloudAiplatformV1beta1RagChunk", -"description": "Additional context for the RAG retrieval result. This is only populated when using the RAG retrieval tool." +"description": "Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used." }, "text": { -"description": "Text of the attribution.", +"description": "The content of the retrieved data source.", "type": "string" }, "title": { -"description": "Title of the attribution.", +"description": "The title of the retrieved data source.", "type": "string" }, "uri": { -"description": "URI reference of the attribution.", +"description": "The URI of the retrieved data source.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunkWeb": { -"description": "Chunk from the web.", +"description": "A `Web` chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", "properties": { "domain": { -"description": "Domain of the (original) URI.", +"description": "The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.", "type": "string" }, "title": { -"description": "Title of the chunk.", +"description": "The title of the web page that contains the evidence.", "type": "string" }, "uri": { -"description": "URI reference of the chunk.", +"description": "The URI of the web page that contains the evidence.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingMetadata": { -"description": "Metadata returned to client when grounding is enabled.", +"description": "Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { "googleMapsWidgetContextToken": { -"description": "Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.", +"description": "Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.", "readOnly": true, "type": "string" }, "groundingChunks": { -"description": "List of supporting references retrieved from specified grounding source.", +"description": "A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk" }, "type": "array" }, "groundingSupports": { -"description": "Optional. List of grounding support.", +"description": "Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport" }, @@ -1648,11 +1648,11 @@ }, "retrievalMetadata": { "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata", -"description": "Optional. Output only. Retrieval metadata.", +"description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, "retrievalQueries": { -"description": "Optional. Queries executed by the retrieval tools.", +"description": "Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.", "items": { "type": "string" }, @@ -1660,10 +1660,10 @@ }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", -"description": "Optional. Google search entry for the following-up web searches." +"description": "Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search." }, "sourceFlaggingUris": { -"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", +"description": "Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" }, @@ -1671,7 +1671,7 @@ "type": "array" }, "webSearchQueries": { -"description": "Optional. Web search queries for the following-up web search.", +"description": "Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.", "items": { "type": "string" }, @@ -1681,26 +1681,26 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { -"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", +"description": "A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", "properties": { "flagContentUri": { -"description": "A link where users can flag a problem with the source (place or review).", +"description": "The URI that can be used to flag the content.", "type": "string" }, "sourceId": { -"description": "Id of the place or review.", +"description": "The ID of the place or review.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingSupport": { -"description": "Grounding support.", +"description": "A collection of supporting references for a segment of the model's response.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", "properties": { "confidenceScores": { -"description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. For Gemini 2.0 and before, this list must have the same size as the grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and should be ignored.", +"description": "The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.", "items": { "format": "float", "type": "number" @@ -1708,7 +1708,7 @@ "type": "array" }, "groundingChunkIndices": { -"description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", +"description": "A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.", "items": { "format": "int32", "type": "integer" @@ -1717,13 +1717,13 @@ }, "segment": { "$ref": "GoogleCloudAiplatformV1beta1Segment", -"description": "Segment of the content this support belongs to." +"description": "The content segment that this support message applies to." } }, "type": "object" }, "GoogleCloudAiplatformV1beta1ImageConfig": { -"description": "Config for image generation features.", +"description": "Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people.", "id": "GoogleCloudAiplatformV1beta1ImageConfig", "properties": { "aspectRatio": { @@ -1743,10 +1743,10 @@ "ALLOW_NONE" ], "enumDescriptions": [ -"Generation images of people unspecified.", -"Generate images that include adults and children.", -"Generate images of adults, but not children.", -"Block generation of images of people." +"The default behavior is unspecified. The model will decide whether to generate images of people.", +"Allows the model to generate images of people, including adults and children.", +"Allows the model to generate images of adults, but not children.", +"Prevents the model from generating images of people." ], "type": "string" } @@ -1770,18 +1770,18 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResult": { -"description": "Logprobs Result", +"description": "The log probabilities of the tokens generated by the model. This is useful for understanding the model's confidence in its predictions and for debugging. For example, you can use log probabilities to identify when the model is making a less confident prediction or to explore alternative responses that the model considered. A low log probability can also indicate that the model is \"hallucinating\" or generating factually incorrect information.", "id": "GoogleCloudAiplatformV1beta1LogprobsResult", "properties": { "chosenCandidates": { -"description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", +"description": "A list of the chosen candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps. Note that the chosen candidate might not be in `top_candidates`.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, "type": "array" }, "topCandidates": { -"description": "Length = total number of decoding steps.", +"description": "A list of the top candidate tokens at each decoding step. The length of this list is equal to the total number of decoding steps.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates" }, @@ -1791,20 +1791,20 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": { -"description": "Candidate for the logprobs token and score.", +"description": "A single token and its associated log probability.", "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate", "properties": { "logProbability": { -"description": "The candidate's log probability.", +"description": "The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain.", "format": "float", "type": "number" }, "token": { -"description": "The candidate's token string value.", +"description": "The token's string representation.", "type": "string" }, "tokenId": { -"description": "The candidate's token id value.", +"description": "The token's numerical ID. While the `token` field provides the string representation of the token, the `token_id` is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary.", "format": "int32", "type": "integer" } @@ -1812,11 +1812,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": { -"description": "Candidates with top log probabilities at each decoding step.", +"description": "A list of the top candidate tokens and their log probabilities at each decoding step. This can be used to see what other tokens the model considered.", "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates", "properties": { "candidates": { -"description": "Sorted by log probability in descending order.", +"description": "The list of candidate tokens, sorted by log probability in descending order.", "items": { "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" }, @@ -1826,11 +1826,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModalityTokenCount": { -"description": "Represents token counting info for a single modality.", +"description": "Represents a breakdown of token usage by modality. This message is used in CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a detailed view of how many tokens are used by each modality (e.g., text, image, video) in a request. This is particularly useful for multimodal models, allowing you to track and manage token consumption for billing and quota purposes.", "id": "GoogleCloudAiplatformV1beta1ModalityTokenCount", "properties": { "modality": { -"description": "The modality associated with this token count.", +"description": "The modality that this token count applies to.", "enum": [ "MODALITY_UNSPECIFIED", "TEXT", @@ -1840,17 +1840,17 @@ "DOCUMENT" ], "enumDescriptions": [ -"Unspecified modality.", -"Plain text.", -"Image.", -"Video.", -"Audio.", -"Document, e.g. PDF." +"When a modality is not specified, it is treated as `TEXT`.", +"The `Part` contains plain text.", +"The `Part` contains an image.", +"The `Part` contains a video.", +"The `Part` contains audio.", +"The `Part` contains a document, such as a PDF." ], "type": "string" }, "tokenCount": { -"description": "Number of tokens.", +"description": "The number of tokens counted for this modality.", "format": "int32", "type": "integer" } @@ -1858,22 +1858,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ModelArmorConfig": { -"description": "Configuration for Model Armor integrations of prompt and responses.", +"description": "Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks.", "id": "GoogleCloudAiplatformV1beta1ModelArmorConfig", "properties": { "promptTemplateName": { -"description": "Optional. The name of the Model Armor template to use for prompt sanitization.", +"description": "Optional. The resource name of the Model Armor template to use for prompt screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the user's prompt for safety and security risks before it is sent to the model. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" }, "responseTemplateName": { -"description": "Optional. The name of the Model Armor template to use for response sanitization.", +"description": "Optional. The resource name of the Model Armor template to use for response screening. A Model Armor template is a set of customized filters and thresholds that define how Model Armor screens content. If specified, Model Armor will use this template to check the model's response for safety and security risks before it is returned to the user. The name must be in the format `projects/{project}/locations/{location}/templates/{template}`.", "type": "string" } }, "type": "object" }, "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { -"description": "Configuration for a multi-speaker text-to-speech setup. Enables the use of up to two distinct voices in a single synthesis request.", +"description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", "properties": { "speakerVoiceConfigs": { @@ -1887,39 +1887,39 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Part": { -"description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", +"description": "A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1beta1Part", "properties": { "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult", -"description": "Optional. Result of executing the [ExecutableCode]." +"description": "Optional. The result of executing the ExecutableCode." }, "executableCode": { "$ref": "GoogleCloudAiplatformV1beta1ExecutableCode", -"description": "Optional. Code generated by the model that is meant to be executed." +"description": "Optional. Code generated by the model that is intended to be executed." }, "fileData": { "$ref": "GoogleCloudAiplatformV1beta1FileData", -"description": "Optional. URI based data." +"description": "Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage." }, "functionCall": { "$ref": "GoogleCloudAiplatformV1beta1FunctionCall", -"description": "Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values." +"description": "Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function." }, "functionResponse": { "$ref": "GoogleCloudAiplatformV1beta1FunctionResponse", -"description": "Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model." +"description": "Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted." }, "inlineData": { "$ref": "GoogleCloudAiplatformV1beta1Blob", -"description": "Optional. Inlined bytes data." +"description": "Optional. The inline data content of the part. This can be used to include images, audio, or video in a request." }, "text": { -"description": "Optional. Text part (can be code).", +"description": "Optional. The text content of the part.", "type": "string" }, "thought": { -"description": "Optional. Indicates if the part is thought from the model.", +"description": "Optional. Indicates whether the `part` represents the model's thought process or reasoning.", "type": "boolean" }, "thoughtSignature": { @@ -1935,11 +1935,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig": { -"description": "The configuration for the prebuilt speaker to use.", +"description": "Configuration for a prebuilt voice.", "id": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", "properties": { "voiceName": { -"description": "The name of the preset voice to use.", +"description": "The name of the prebuilt voice to use.", "type": "string" } }, @@ -2111,11 +2111,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1RetrievalMetadata": { -"description": "Metadata related to retrieval in the grounding flow.", +"description": "Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata", "properties": { "googleSearchDynamicRetrievalScore": { -"description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.", +"description": "Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.", "format": "float", "type": "number" } @@ -2123,16 +2123,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SafetyRating": { -"description": "Safety rating corresponding to the generated content.", +"description": "A safety rating for a piece of content. The safety rating contains the harm category and the harm probability level.", "id": "GoogleCloudAiplatformV1beta1SafetyRating", "properties": { "blocked": { -"description": "Output only. Indicates whether the content was filtered out because of this rating.", +"description": "Output only. Indicates whether the content was blocked because of this rating.", "readOnly": true, "type": "boolean" }, "category": { -"description": "Output only. Harm category.", +"description": "Output only. The harm category of this rating.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -2160,17 +2160,17 @@ false, false ], "enumDescriptions": [ -"The harm category is unspecified.", -"The harm category is hate speech.", -"The harm category is dangerous content.", -"The harm category is harassment.", -"The harm category is sexually explicit content.", +"Default value. This value is unused.", +"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", +"Content that promotes, facilitates, or enables dangerous activities.", +"Abusive, threatening, or content intended to bully, torment, or ridicule.", +"Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", -"The harm category is image hate.", -"The harm category is image dangerous content.", -"The harm category is image harassment.", -"The harm category is image sexually explicit content.", -"The harm category is for jailbreak prompts." +"Images that contain hate speech.", +"Images that contain dangerous content.", +"Images that contain harassment.", +"Images that contain sexually explicit content.", +"Prompts designed to bypass safety filters." ], "readOnly": true, "type": "string" @@ -2186,18 +2186,18 @@ false "OFF" ], "enumDescriptions": [ -"Unspecified harm block threshold.", -"Block low threshold and above (i.e. block more).", -"Block medium threshold and above.", -"Block only high threshold (i.e. block less).", -"Block none.", -"Turn off the safety filter." +"The harm block threshold is unspecified.", +"Block content with a low harm probability or higher.", +"Block content with a medium harm probability or higher.", +"Block content with a high harm probability.", +"Do not block any content, regardless of its harm probability.", +"Turn off the safety filter entirely." ], "readOnly": true, "type": "string" }, "probability": { -"description": "Output only. Harm probability levels in the content.", +"description": "Output only. The probability of harm for this category.", "enum": [ "HARM_PROBABILITY_UNSPECIFIED", "NEGLIGIBLE", @@ -2206,23 +2206,23 @@ false "HIGH" ], "enumDescriptions": [ -"Harm probability unspecified.", -"Negligible level of harm.", -"Low level of harm.", -"Medium level of harm.", -"High level of harm." +"The harm probability is unspecified.", +"The harm probability is negligible.", +"The harm probability is low.", +"The harm probability is medium.", +"The harm probability is high." ], "readOnly": true, "type": "string" }, "probabilityScore": { -"description": "Output only. Harm probability score.", +"description": "Output only. The probability score of harm for this category.", "format": "float", "readOnly": true, "type": "number" }, "severity": { -"description": "Output only. Harm severity levels in the content.", +"description": "Output only. The severity of harm for this category.", "enum": [ "HARM_SEVERITY_UNSPECIFIED", "HARM_SEVERITY_NEGLIGIBLE", @@ -2231,17 +2231,17 @@ false "HARM_SEVERITY_HIGH" ], "enumDescriptions": [ -"Harm severity unspecified.", -"Negligible level of harm severity.", -"Low level of harm severity.", -"Medium level of harm severity.", -"High level of harm severity." +"The harm severity is unspecified.", +"The harm severity is negligible.", +"The harm severity is low.", +"The harm severity is medium.", +"The harm severity is high." ], "readOnly": true, "type": "string" }, "severityScore": { -"description": "Output only. Harm severity score.", +"description": "Output only. The severity score of harm for this category.", "format": "float", "readOnly": true, "type": "number" @@ -2250,11 +2250,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SafetySetting": { -"description": "Safety settings.", +"description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", "id": "GoogleCloudAiplatformV1beta1SafetySetting", "properties": { "category": { -"description": "Required. Harm category.", +"description": "Required. The harm category to be blocked.", "enum": [ "HARM_CATEGORY_UNSPECIFIED", "HARM_CATEGORY_HATE_SPEECH", @@ -2282,22 +2282,22 @@ false, false ], "enumDescriptions": [ -"The harm category is unspecified.", -"The harm category is hate speech.", -"The harm category is dangerous content.", -"The harm category is harassment.", -"The harm category is sexually explicit content.", +"Default value. This value is unused.", +"Content that promotes violence or incites hatred against individuals or groups based on certain attributes.", +"Content that promotes, facilitates, or enables dangerous activities.", +"Abusive, threatening, or content intended to bully, torment, or ridicule.", +"Content that contains sexually explicit material.", "Deprecated: Election filter is not longer supported. The harm category is civic integrity.", -"The harm category is image hate.", -"The harm category is image dangerous content.", -"The harm category is image harassment.", -"The harm category is image sexually explicit content.", -"The harm category is for jailbreak prompts." +"Images that contain hate speech.", +"Images that contain dangerous content.", +"Images that contain harassment.", +"Images that contain sexually explicit content.", +"Prompts designed to bypass safety filters." ], "type": "string" }, "method": { -"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.", +"description": "Optional. The method for blocking content. If not specified, the default behavior is to use the probability score.", "enum": [ "HARM_BLOCK_METHOD_UNSPECIFIED", "SEVERITY", @@ -2311,7 +2311,7 @@ false "type": "string" }, "threshold": { -"description": "Required. The harm block threshold.", +"description": "Required. The threshold for blocking content. If the harm probability exceeds this threshold, the content will be blocked.", "enum": [ "HARM_BLOCK_THRESHOLD_UNSPECIFIED", "BLOCK_LOW_AND_ABOVE", @@ -2321,12 +2321,12 @@ false "OFF" ], "enumDescriptions": [ -"Unspecified harm block threshold.", -"Block low threshold and above (i.e. block more).", -"Block medium threshold and above.", -"Block only high threshold (i.e. block less).", -"Block none.", -"Turn off the safety filter." +"The harm block threshold is unspecified.", +"Block content with a low harm probability or higher.", +"Block content with a medium harm probability or higher.", +"Block content with a high harm probability.", +"Do not block any content, regardless of its harm probability.", +"Turn off the safety filter entirely." ], "type": "string" } @@ -2487,15 +2487,15 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SearchEntryPoint": { -"description": "Google search entry point.", +"description": "An entry point for displaying Google Search results. A `SearchEntryPoint` is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.", "id": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "properties": { "renderedContent": { -"description": "Optional. Web content snippet that can be embedded in a web page or an app webview.", +"description": "Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.", "type": "string" }, "sdkBlob": { -"description": "Optional. Base64 encoded JSON representing array of tuple.", +"description": "Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.", "format": "byte", "type": "string" } @@ -2503,29 +2503,29 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1Segment": { -"description": "Segment of the content.", +"description": "A segment of the content.", "id": "GoogleCloudAiplatformV1beta1Segment", "properties": { "endIndex": { -"description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", +"description": "Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.", "format": "int32", "readOnly": true, "type": "integer" }, "partIndex": { -"description": "Output only. The index of a Part object within its parent Content object.", +"description": "Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.", "format": "int32", "readOnly": true, "type": "integer" }, "startIndex": { -"description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", +"description": "Output only. The start index of the segment in the `Part`, measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.", "format": "int32", "readOnly": true, "type": "integer" }, "text": { -"description": "Output only. The text corresponding to the segment from the response.", +"description": "Output only. The text of the segment.", "readOnly": true, "type": "string" } @@ -2533,7 +2533,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig": { -"description": "Configuration for a single speaker in a multi speaker setup.", +"description": "Configuration for a single speaker in a multi-speaker setup.", "id": "GoogleCloudAiplatformV1beta1SpeakerVoiceConfig", "properties": { "speaker": { @@ -2548,11 +2548,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1SpeechConfig": { -"description": "The speech generation config.", +"description": "Configuration for speech generation.", "id": "GoogleCloudAiplatformV1beta1SpeechConfig", "properties": { "languageCode": { -"description": "Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization.", +"description": "Optional. The language code (ISO 639-1) for the speech synthesis.", "type": "string" }, "multiSpeakerVoiceConfig": { @@ -2561,7 +2561,7 @@ false }, "voiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1VoiceConfig", -"description": "The configuration for the speaker to use." +"description": "The configuration for the voice to use." } }, "type": "object" @@ -2636,7 +2636,7 @@ false "type": "string" }, "excludedPredefinedFunctions": { -"description": "Optional. By default, predefined functions are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", +"description": "Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.", "items": { "type": "string" }, @@ -2703,11 +2703,11 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1UrlContextMetadata": { -"description": "Metadata related to url context retrieval tool.", +"description": "Metadata returned when the model uses the `url_context` tool to get information from a user-provided URL.", "id": "GoogleCloudAiplatformV1beta1UrlContextMetadata", "properties": { "urlMetadata": { -"description": "Output only. List of url context.", +"description": "Output only. A list of URL metadata, with one entry for each URL retrieved by the tool.", "items": { "$ref": "GoogleCloudAiplatformV1beta1UrlMetadata" }, @@ -2718,15 +2718,15 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1UrlMetadata": { -"description": "Context of the a single url retrieval.", +"description": "The metadata for a single URL retrieval.", "id": "GoogleCloudAiplatformV1beta1UrlMetadata", "properties": { "retrievedUrl": { -"description": "Retrieved url by the tool.", +"description": "The URL retrieved by the tool.", "type": "string" }, "urlRetrievalStatus": { -"description": "Status of the url retrieval.", +"description": "The status of the URL retrieval.", "enum": [ "URL_RETRIEVAL_STATUS_UNSPECIFIED", "URL_RETRIEVAL_STATUS_SUCCESS", @@ -2734,8 +2734,8 @@ false ], "enumDescriptions": [ "Default value. This value is unused.", -"Url retrieval is successful.", -"Url retrieval is failed due to error." +"The URL was retrieved successfully.", +"The URL retrieval failed." ], "type": "string" } @@ -2849,7 +2849,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1VideoMetadata": { -"description": "Metadata describes the input video content.", +"description": "Provides metadata for a video, including the start and end offsets for clipping and the frame rate.", "id": "GoogleCloudAiplatformV1beta1VideoMetadata", "properties": { "endOffset": { @@ -2858,7 +2858,7 @@ false "type": "string" }, "fps": { -"description": "Optional. The frame rate of the video sent to the model. If not specified, the default value will be 1.0. The fps range is (0.0, 24.0].", +"description": "Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].", "format": "double", "type": "number" }, @@ -2871,12 +2871,12 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1VoiceConfig": { -"description": "The configuration for the voice to use.", +"description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1beta1VoiceConfig", "properties": { "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", -"description": "The configuration for the prebuilt voice to use." +"description": "The configuration for a prebuilt voice." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 7b2dd439ae..a1c28e956d 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -2284,7 +2284,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2416,7 +2416,7 @@ } } }, -"revision": "20251014", +"revision": "20251026", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 3f898162bc..10d168176a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -192,7 +192,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2122,7 +2122,7 @@ } } }, -"revision": "20251002", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 6913a9542b..89be89c9cf 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -192,7 +192,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2266,7 +2266,7 @@ } } }, -"revision": "20251002", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index e268cdd291..52a304e11c 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -192,7 +192,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2122,7 +2122,7 @@ } } }, -"revision": "20251002", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index e5e8adb97b..7cbcb61556 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -723,7 +723,7 @@ } } }, -"revision": "20250925", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2.json b/googleapiclient/discovery_cache/documents/gkehub.v2.json index dd0d39ad47..3c17151fcb 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, -"revision": "20251002", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index b37afdc936..dca0c3e9be 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, -"revision": "20251002", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index 8068810589..f8d9a2a590 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -482,7 +482,7 @@ } } }, -"revision": "20251002", +"revision": "20251026", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json index 2c1f91a54f..ca4c55ba5b 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json @@ -1239,7 +1239,7 @@ } } }, -"revision": "20250130", +"revision": "20251024", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { @@ -2440,7 +2440,7 @@ true "type": "object" }, "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest": { -"description": "Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.", +"description": "Request message for SendVerificationCode. 'captcha_response' is required when reCAPTCHA enterprise is enabled, or otherwise at least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator.", "id": "GoogleCloudIdentitytoolkitV1SendVerificationCodeRequest", "properties": { "autoRetrievalInfo": { @@ -2468,7 +2468,7 @@ true "type": "string" }, "iosReceipt": { -"description": "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.", +"description": "Receipt of successful iOS app token validation. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). This should come from the response of verifyIosClient. If present, the caller should also provide the `ios_secret`, as well as a bundle ID in the `x-ios-bundle-identifier` header, which must match the bundle ID from the verifyIosClient request.", "type": "string" }, "iosSecret": { @@ -2484,7 +2484,7 @@ true "type": "string" }, "recaptchaToken": { -"description": "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.", +"description": "Recaptcha token for app verification. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `play_integrity_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). The recaptcha should be generated by calling getRecaptchaParams and the recaptcha token will be generated on user completion of the recaptcha challenge.", "type": "string" }, "recaptchaVersion": { @@ -2500,7 +2500,7 @@ true "type": "string" }, "safetyNetToken": { -"description": "Android only. Used to assert application identity in place of a recaptcha token. At least one of (`ios_receipt` and `ios_secret`), `recaptcha_token`, or `safety_net_token` must be specified to verify the verification code is being sent on behalf of a real app and not an emulator, if 'captcha_response' is not used (reCAPTCHA enterprise is not enabled). A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.", +"description": "Android only. Safety Net has been deprecated. Please use play_integrity_token instead.", "type": "string" }, "tenantId": { diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index 416f01d442..b40b438b0e 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -246,7 +246,7 @@ } } }, -"revision": "20250824", +"revision": "20251026", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -699,6 +699,7 @@ "G2", "G4", "C3", +"C4", "M2", "M1", "N1", @@ -719,6 +720,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -897,7 +899,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1066,6 +1095,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1642,7 +1698,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1811,6 +1894,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2336,7 +2446,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -2505,6 +2642,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2528,6 +2692,7 @@ "E2", "G2", "G4", +"C4", "C3", "M2", "M1", @@ -2549,6 +2714,7 @@ "", "", "", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/googleapiclient/discovery_cache/documents/language.v1beta2.json b/googleapiclient/discovery_cache/documents/language.v1beta2.json index c521129092..56c7ad6dde 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -246,7 +246,7 @@ } } }, -"revision": "20250824", +"revision": "20251026", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -699,6 +699,7 @@ "G2", "G4", "C3", +"C4", "M2", "M1", "N1", @@ -719,6 +720,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -897,7 +899,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1066,6 +1095,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1660,7 +1716,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1829,6 +1912,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2354,7 +2464,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -2523,6 +2660,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -2546,6 +2710,7 @@ "E2", "G2", "G4", +"C4", "C3", "M2", "M1", @@ -2567,6 +2732,7 @@ "", "", "", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/googleapiclient/discovery_cache/documents/language.v2.json b/googleapiclient/discovery_cache/documents/language.v2.json index 936a44d4d1..fae03138b3 100644 --- a/googleapiclient/discovery_cache/documents/language.v2.json +++ b/googleapiclient/discovery_cache/documents/language.v2.json @@ -208,7 +208,7 @@ } } }, -"revision": "20250824", +"revision": "20251026", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -524,6 +524,7 @@ "G2", "G4", "C3", +"C4", "M2", "M1", "N1", @@ -544,6 +545,7 @@ "GPU-based machine, skip quota reporting.", "GPU-based machine, skip quota reporting.", "", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", @@ -722,7 +724,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -891,6 +920,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1281,7 +1337,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1450,6 +1533,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1730,7 +1840,34 @@ "C3_HIGHMEM_22", "C3_HIGHMEM_44", "C3_HIGHMEM_88", -"C3_HIGHMEM_176" +"C3_HIGHMEM_176", +"C4_STANDARD_8", +"C4_STANDARD_16", +"C4_STANDARD_24", +"C4_STANDARD_32", +"C4_STANDARD_48", +"C4_STANDARD_96", +"C4_STANDARD_144", +"C4_STANDARD_192", +"C4_STANDARD_288", +"C4_HIGHCPU_8", +"C4_HIGHCPU_16", +"C4_HIGHCPU_24", +"C4_HIGHCPU_32", +"C4_HIGHCPU_48", +"C4_HIGHCPU_96", +"C4_HIGHCPU_144", +"C4_HIGHCPU_192", +"C4_HIGHCPU_288", +"C4_HIGHMEM_8", +"C4_HIGHMEM_16", +"C4_HIGHMEM_24", +"C4_HIGHMEM_32", +"C4_HIGHMEM_48", +"C4_HIGHMEM_96", +"C4_HIGHMEM_144", +"C4_HIGHMEM_192", +"C4_HIGHMEM_288" ], "enumDescriptions": [ "", @@ -1899,6 +2036,33 @@ "", "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -1922,6 +2086,7 @@ "E2", "G2", "G4", +"C4", "C3", "M2", "M1", @@ -1943,6 +2108,7 @@ "", "", "", +"", "MEMORY_OPTIMIZED_UPGRADE_PREMIUM", "MEMORY_OPTIMIZED", "", diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json index 283a706053..31557e284e 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1695,7 +1695,7 @@ } } }, -"revision": "20250925", +"revision": "20251023", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index d39e281d48..71cee28bee 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1807,7 +1807,7 @@ } } }, -"revision": "20250925", +"revision": "20251023", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index 04c6752f11..fef02bceb5 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1807,7 +1807,7 @@ } } }, -"revision": "20250925", +"revision": "20251023", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index c47e0f5885..ffccace398 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20240707", +"revision": "20251022", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { @@ -359,7 +359,8 @@ "FOOD_ORDERING", "FOOD_DELIVERY", "FOOD_TAKEOUT", -"SHOP_ONLINE" +"SHOP_ONLINE", +"SOLOPRENEUR_APPOINTMENT" ], "enumDescriptions": [ "Not specified.", @@ -369,7 +370,8 @@ "The action type is ordering food for delivery and/or takeout.", "The action type is ordering food for delivery.", "The action type is ordering food for takeout.", -"The action type is shopping, that can be delivery and/or pickup." +"The action type is shopping, that can be delivery and/or pickup.", +"The action type is booking an appointment with a Solopneuer partner." ], "type": "string" }, @@ -419,7 +421,8 @@ "FOOD_ORDERING", "FOOD_DELIVERY", "FOOD_TAKEOUT", -"SHOP_ONLINE" +"SHOP_ONLINE", +"SOLOPRENEUR_APPOINTMENT" ], "enumDescriptions": [ "Not specified.", @@ -429,7 +432,8 @@ "The action type is ordering food for delivery and/or takeout.", "The action type is ordering food for delivery.", "The action type is ordering food for takeout.", -"The action type is shopping, that can be delivery and/or pickup." +"The action type is shopping, that can be delivery and/or pickup.", +"The action type is booking an appointment with a Solopneuer partner." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 29bf085f2f..d6f47e8fb2 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -356,7 +356,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2515,7 +2515,7 @@ } } }, -"revision": "20251009", +"revision": "20251029", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3323,7 +3323,7 @@ "type": "string" }, "cryptoKeyName": { -"description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.", +"description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 9c7f295cfd..b648302427 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -356,7 +356,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2543,7 +2543,7 @@ } } }, -"revision": "20251009", +"revision": "20251029", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -3377,7 +3377,7 @@ "type": "string" }, "cryptoKeyName": { -"description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}.", +"description": "Required. Customer managed crypto key resource full name. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index 7f02dcc49b..02c7a25317 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1127,7 +1127,7 @@ } } }, -"revision": "20250925", +"revision": "20251030", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AllocationOptions": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index ce91da0347..cf23f0fc51 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -521,7 +521,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1233,7 +1233,7 @@ } } }, -"revision": "20251008", +"revision": "20251022", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 4a229ce1f9..4d6ab03f1c 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -525,7 +525,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1237,7 +1237,7 @@ } } }, -"revision": "20251008", +"revision": "20251022", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { diff --git a/googleapiclient/discovery_cache/documents/observability.v1.json b/googleapiclient/discovery_cache/documents/observability.v1.json index 176183f57d..b25d67a772 100644 --- a/googleapiclient/discovery_cache/documents/observability.v1.json +++ b/googleapiclient/discovery_cache/documents/observability.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -536,7 +536,7 @@ } } }, -"revision": "20250925", +"revision": "20251023", "rootUrl": "https://observability.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index a51c9a1fae..0a4511c1f1 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2472,7 +2472,7 @@ } } }, -"revision": "20251009", +"revision": "20251022", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1.json b/googleapiclient/discovery_cache/documents/parallelstore.v1.json index e702dcc19f..7a9c6618a5 100644 --- a/googleapiclient/discovery_cache/documents/parallelstore.v1.json +++ b/googleapiclient/discovery_cache/documents/parallelstore.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -554,7 +554,7 @@ } } }, -"revision": "20250924", +"revision": "20251022", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json index 36bfd9e0c4..ce99bed098 100644 --- a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -551,7 +551,7 @@ } } }, -"revision": "20250924", +"revision": "20251022", "rootUrl": "https://parallelstore.googleapis.com/", "schemas": { "DestinationGcsBucket": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json index 7850badcb3..d529bc5b14 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1616,7 +1616,7 @@ } } }, -"revision": "20250926", +"revision": "20251022", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index ef3bda9eb1..a6413400a3 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -591,7 +591,7 @@ } } }, -"revision": "20250926", +"revision": "20251022", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index c6a29d902f..d261cc2bdd 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -786,7 +786,7 @@ } } }, -"revision": "20251006", +"revision": "20251026", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -918,7 +918,6 @@ "type": "string" }, "annotation": { -"description": "Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.", "enum": [ "ANNOTATION_UNSPECIFIED", "LEGITIMATE", @@ -952,7 +951,6 @@ true "description": "Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes." }, "reasons": { -"description": "Optional. Reasons for the annotation that are assigned to the event.", "items": { "enum": [ "REASON_UNSPECIFIED", @@ -1092,7 +1090,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment", "properties": { "client": { -"description": "Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - \"github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager\" - \"cloud.google.com/recaptcha/docs/implement-waf-akamai\" - \"cloud.google.com/recaptcha/docs/implement-waf-cloudflare\" - \"wordpress.org/plugins/recaptcha-something\"", +"description": "Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - \"github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager\" - \"wordpress.org/plugins/recaptcha-something\"", "type": "string" }, "version": { @@ -2177,7 +2175,8 @@ true "EXPIRED", "DUPE", "MISSING", -"BROWSER_ERROR" +"BROWSER_ERROR", +"UNEXPECTED_ACTION" ], "enumDescriptions": [ "Default unspecified type.", @@ -2186,7 +2185,8 @@ true "The user verification token had expired.", "The user verification had already been seen.", "The user verification token was not present.", -"A retriable error (such as network failure) occurred on the browser. Could easily be simulated by an attacker." +"A retriable error (such as network failure) occurred on the browser. Could easily be simulated by an attacker.", +"The action provided at token generation was different than the `expected_action` in the assessment request. The comparison is case-insensitive. This reason can only be returned if all of the following are true: - your `site_key` has the POLICY_BASED_CHALLENGE integration type - you set an action score threshold higher than 0.0 - you provided a non-empty `expected_action`" ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index aec3798f91..af02be86a7 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -119,7 +119,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -596,7 +596,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -972,7 +972,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1449,7 +1449,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -1944,7 +1944,7 @@ } } }, -"revision": "20250907", +"revision": "20251026", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 92e915b09e..f1086811c2 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -1742,7 +1742,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -2907,7 +2907,7 @@ } } }, -"revision": "20251003", +"revision": "20251024", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 942e4d5d5d..51e9afd08e 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1942,7 +1942,7 @@ } } }, -"revision": "20251003", +"revision": "20251024", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json index aec0adc59d..025ecc77ef 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -889,7 +889,7 @@ } } }, -"revision": "20250906", +"revision": "20251030", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json index 8fd9038f23..2542dfd4a3 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -977,7 +977,7 @@ } } }, -"revision": "20250906", +"revision": "20251030", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 0688769c6f..385d56ef6a 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -835,7 +835,7 @@ } } }, -"revision": "20251001", +"revision": "20251027", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1584,7 +1584,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 7ee934062d..5dc5e76afc 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1034,7 +1034,7 @@ } } }, -"revision": "20250929", +"revision": "20251027", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1932,7 +1932,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index cdb5a0cbbf..5742231272 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20250722", +"revision": "20251027", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1076,7 +1076,7 @@ "id": "Control", "properties": { "environment": { -"description": "The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com", +"description": "The service controller environment to use. If empty, no control plane features (like quota and billing) will be enabled. The recommended value for most services is servicecontrol.googleapis.com.", "type": "string" }, "methodPolicies": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 5a32d75da1..132f28a7dc 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -3406,7 +3406,7 @@ } } }, -"revision": "20250920", +"revision": "20251014", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AdaptMessageRequest": { @@ -7601,7 +7601,7 @@ ], "enumDescriptions": [ "Default value. If the value is not specified, the `SERIALIZABLE` isolation level is used.", -"All transactions appear as if they executed in a serial order, even if some of the reads, writes, and other operations of distinct transactions actually occurred in parallel. Spanner assigns commit timestamps that reflect the order of committed transactions to implement this property. Spanner offers a stronger guarantee than serializability called external consistency. For further details, please refer to https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability.", +"All transactions appear as if they executed in a serial order, even if some of the reads, writes, and other operations of distinct transactions actually occurred in parallel. Spanner assigns commit timestamps that reflect the order of committed transactions to implement this property. Spanner offers a stronger guarantee than serializability called external consistency. For more information, see [TrueTime and external consistency](https://cloud.google.com/spanner/docs/true-time-external-consistency#serializability).", "All reads performed during the transaction observe a consistent snapshot of the database, and the transaction is only successfully committed in the absence of conflicts between its updates and any concurrent updates that have occurred since that snapshot. Consequently, in contrast to `SERIALIZABLE` transactions, only write-write conflicts are detected in snapshot transactions. This isolation level does not support Read-only and Partitioned DML transactions. When `REPEATABLE_READ` is specified on a read-write transaction, the locking semantics default to `OPTIMISTIC`." ], "type": "string" @@ -7667,7 +7667,8 @@ "JSON", "PROTO", "ENUM", -"INTERVAL" +"INTERVAL", +"UUID" ], "enumDescriptions": [ "Not specified.", @@ -7685,7 +7686,8 @@ "Encoded as a JSON-formatted `string` as described in RFC 7159. The following rules are applied when parsing JSON input: - Whitespace characters are not preserved. - If a JSON object has duplicate keys, only the first key is preserved. - Members of a JSON object are not guaranteed to have their order preserved. - JSON array elements will have their order preserved.", "Encoded as a base64-encoded `string`, as described in RFC 4648, section 4.", "Encoded as `string`, in decimal format.", -"Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer. For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds." +"Encoded as `string`, in `ISO8601` duration format - `P[n]Y[n]M[n]DT[n]H[n]M[n[.fraction]]S` where `n` is an integer. For example, `P1Y2M3DT4H5M6.5S` represents time duration of 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6.5 seconds.", +"Encoded as `string`, in lower-case hexa-decimal format, as described in RFC 9562, section 4." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json index 95fee44bca..08107fd68d 100644 --- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -487,7 +487,7 @@ } } }, -"revision": "20251015", +"revision": "20251022", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "Bucket": { diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 7162d8aef8..c206e99dec 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20251008", +"revision": "20251102", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { @@ -505,7 +505,7 @@ "type": "string" }, "carrierCode": { -"description": "Optional. IATA carrier code, e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).", +"description": "Optional. 2-character [IATA carrier code](https://www.iata.org/en/publications/directories/code-search/), e.g. `KE`. This is required if specific flight matching is desired. Otherwise, this is unused for typical flight and distance-based emissions models. This could be both operating and marketing carrier code (i.e. codeshare is covered).", "type": "string" }, "departureDate": { @@ -513,21 +513,21 @@ "description": "Required. Date of the flight in the time zone of the origin airport. Only year is required for typical flight and distance-based emissions models (month and day values are ignored and therefore, can be either omitted, set to 0, or set to a valid date for those cases). Correspondingly, if a specific date is not provided for TIM emissions, we will fallback to typical flight (or distance-based) emissions." }, "destination": { -"description": "Optional. IATA airport code for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", +"description": "Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight destination, e.g. `ICN`. This is used to match specific flight if provided alongside origin, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", "type": "string" }, "distanceKm": { -"description": "Optional. Distance in kilometers, e.g. `2423`. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights. This field supports values between 0 and 2.5e16 km.", +"description": "Optional. Distance in kilometers, e.g. `2423`, from [1, 2.5e16) km. This is used to match a flight to distance-based emissions when origin and destination are not provided or there are no matching typical flights.", "format": "int64", "type": "string" }, "flightNumber": { -"description": "Optional. Flight number, e.g. `71`. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided.", +"description": "Optional. Up to 4-digit [flight number](https://en.wikipedia.org/wiki/Flight_number), e.g. `71`, from [1, 9999]. This is first used to match a specific flight if a flight number is specified alongside origin, destination, and carrier. If a flight number is not specified, we will first try to match the flight to a typical flight between the provided origin and destination airports. If that fails and/or origin & destination are not provided, we will use the distance-based emissions model based on the flight distance provided.", "format": "int32", "type": "integer" }, "origin": { -"description": "Optional. IATA airport code for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", +"description": "Optional. 3-character [IATA airport code](https://www.iata.org/en/publications/directories/code-search/) for flight origin, e.g. `YVR`. This is used to match specific flight if provided alongside destination, carrier, and flight number. If there is no match, we will first try to match the flight to a typical flight between the provided origin and destination airports. Otherwise, we will use the distance-based emissions model if the flight distance is provided.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 47424cc24b..8e054e303b 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", +"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -923,7 +923,7 @@ true } } }, -"revision": "20251001", +"revision": "20251022", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -3430,7 +3430,7 @@ true "additionalProperties": { "type": "string" }, -"description": "Details of the violation.", +"description": "Details of the violation. TODO(b/452163887)", "type": "object" }, "serviceAccount": {